blob: 60354449d9ed1cc16f7ca43fdef340c935d2b1c8 [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>
Kent Overstreeta27bb332013-05-07 16:19:08 -070036#include <linux/aio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/errno.h>
38#include <linux/mtio.h>
39#include <linux/ioctl.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090040#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include <linux/fcntl.h>
42#include <linux/init.h>
43#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/cdev.h>
James Bottomley7c07d612007-08-05 13:36:11 -050046#include <linux/idr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/seq_file.h>
48#include <linux/blkdev.h>
49#include <linux/delay.h>
Christof Schmitt6da127a2008-01-11 10:09:43 +010050#include <linux/blktrace_api.h>
Arnd Bergmannc45d15d2010-06-02 14:28:52 +020051#include <linux/mutex.h>
Douglas Gilbertcc833ac2014-06-25 14:08:03 +020052#include <linux/atomic.h>
Christian Dietrich2fe038e2011-06-04 17:36:10 +020053#include <linux/ratelimit.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 Bottomleyc0d3b9c22013-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...) \
222 sdev_printk(prefix, (sdp)->device, "[%s] " fmt, \
223 (sdp)->disk->disk_name, ##a)
224
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;
549 int err = 0;
550 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:
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +0900578 err = sg_finish_rem_req(srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 return (0 == err) ? count : err;
580}
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{
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400766 int k, data_dir, 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 switch (hp->dxfer_direction) {
797 case SG_DXFER_TO_FROM_DEV:
798 case SG_DXFER_FROM_DEV:
Mike Christied6b10342005-11-08 04:06:41 -0600799 data_dir = DMA_FROM_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 break;
801 case SG_DXFER_TO_DEV:
Mike Christied6b10342005-11-08 04:06:41 -0600802 data_dir = DMA_TO_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 break;
804 case SG_DXFER_UNKNOWN:
Mike Christied6b10342005-11-08 04:06:41 -0600805 data_dir = DMA_BIDIRECTIONAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 break;
807 default:
Mike Christied6b10342005-11-08 04:06:41 -0600808 data_dir = DMA_NONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 break;
810 }
cb59e842005-04-02 13:51:23 -0600811 hp->duration = jiffies_to_msecs(jiffies);
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400812 if (hp->interface_id != '\0' && /* v3 (or later) interface */
813 (SG_FLAG_Q_AT_TAIL & hp->flags))
814 at_head = 0;
815 else
816 at_head = 1;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200817
818 srp->rq->timeout = timeout;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500819 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200820 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400821 srp->rq, at_head, sg_rq_end_io);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200822 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823}
824
Jörn Engel6acddc52012-04-12 17:33:58 -0400825static int srp_done(Sg_fd *sfp, Sg_request *srp)
826{
827 unsigned long flags;
828 int ret;
829
830 read_lock_irqsave(&sfp->rq_list_lock, flags);
831 ret = srp->done;
832 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
833 return ret;
834}
835
Akinobu Mita46f69e62014-06-02 22:56:46 +0900836static int max_sectors_bytes(struct request_queue *q)
837{
838 unsigned int max_sectors = queue_max_sectors(q);
839
840 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
841
842 return max_sectors << 9;
843}
844
Jörn Engel37b9d1e2012-04-12 17:35:05 -0400845static long
Arnd Bergmannf4927c42010-04-27 00:24:01 +0200846sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847{
848 void __user *p = (void __user *)arg;
849 int __user *ip = p;
850 int result, val, read_only;
851 Sg_device *sdp;
852 Sg_fd *sfp;
853 Sg_request *srp;
854 unsigned long iflags;
855
856 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
857 return -ENXIO;
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900858
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200859 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
860 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
862
863 switch (cmd_in) {
864 case SG_IO:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200865 if (atomic_read(&sdp->detaching))
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400866 return -ENODEV;
867 if (!scsi_block_when_processing_errors(sdp->device))
868 return -ENXIO;
869 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
870 return -EFAULT;
871 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
872 1, read_only, 1, &srp);
873 if (result < 0)
874 return result;
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400875 result = wait_event_interruptible(sfp->read_wait,
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200876 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
877 if (atomic_read(&sdp->detaching))
Jörn Engel794c10f2012-04-12 17:32:48 -0400878 return -ENODEV;
879 write_lock_irq(&sfp->rq_list_lock);
880 if (srp->done) {
881 srp->done = 2;
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400882 write_unlock_irq(&sfp->rq_list_lock);
Jörn Engel794c10f2012-04-12 17:32:48 -0400883 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
884 return (result < 0) ? result : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 }
Jörn Engel794c10f2012-04-12 17:32:48 -0400886 srp->orphan = 1;
887 write_unlock_irq(&sfp->rq_list_lock);
888 return result; /* -ERESTARTSYS because signal hit process */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 case SG_SET_TIMEOUT:
890 result = get_user(val, ip);
891 if (result)
892 return result;
893 if (val < 0)
894 return -EIO;
895 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
896 val = MULDIV (INT_MAX, USER_HZ, HZ);
897 sfp->timeout_user = val;
898 sfp->timeout = MULDIV (val, HZ, USER_HZ);
899
900 return 0;
901 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
902 /* strange ..., for backward compatibility */
903 return sfp->timeout_user;
904 case SG_SET_FORCE_LOW_DMA:
905 result = get_user(val, ip);
906 if (result)
907 return result;
908 if (val) {
909 sfp->low_dma = 1;
910 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
911 val = (int) sfp->reserve.bufflen;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200912 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 sg_build_reserve(sfp, val);
914 }
915 } else {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200916 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 return -ENODEV;
918 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
919 }
920 return 0;
921 case SG_GET_LOW_DMA:
922 return put_user((int) sfp->low_dma, ip);
923 case SG_GET_SCSI_ID:
924 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
925 return -EFAULT;
926 else {
927 sg_scsi_id_t __user *sg_idp = p;
928
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200929 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 return -ENODEV;
931 __put_user((int) sdp->device->host->host_no,
932 &sg_idp->host_no);
933 __put_user((int) sdp->device->channel,
934 &sg_idp->channel);
935 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
936 __put_user((int) sdp->device->lun, &sg_idp->lun);
937 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
938 __put_user((short) sdp->device->host->cmd_per_lun,
939 &sg_idp->h_cmd_per_lun);
940 __put_user((short) sdp->device->queue_depth,
941 &sg_idp->d_queue_depth);
942 __put_user(0, &sg_idp->unused[0]);
943 __put_user(0, &sg_idp->unused[1]);
944 return 0;
945 }
946 case SG_SET_FORCE_PACK_ID:
947 result = get_user(val, ip);
948 if (result)
949 return result;
950 sfp->force_packid = val ? 1 : 0;
951 return 0;
952 case SG_GET_PACK_ID:
953 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
954 return -EFAULT;
955 read_lock_irqsave(&sfp->rq_list_lock, iflags);
956 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
957 if ((1 == srp->done) && (!srp->sg_io_owned)) {
958 read_unlock_irqrestore(&sfp->rq_list_lock,
959 iflags);
960 __put_user(srp->header.pack_id, ip);
961 return 0;
962 }
963 }
964 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
965 __put_user(-1, ip);
966 return 0;
967 case SG_GET_NUM_WAITING:
968 read_lock_irqsave(&sfp->rq_list_lock, iflags);
969 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
970 if ((1 == srp->done) && (!srp->sg_io_owned))
971 ++val;
972 }
973 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
974 return put_user(val, ip);
975 case SG_GET_SG_TABLESIZE:
976 return put_user(sdp->sg_tablesize, ip);
977 case SG_SET_RESERVED_SIZE:
978 result = get_user(val, ip);
979 if (result)
980 return result;
981 if (val < 0)
982 return -EINVAL;
Alan Stern44ec9542007-02-20 11:01:57 -0500983 val = min_t(int, val,
Akinobu Mita46f69e62014-06-02 22:56:46 +0900984 max_sectors_bytes(sdp->device->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 if (val != sfp->reserve.bufflen) {
986 if (sg_res_in_use(sfp) || sfp->mmap_called)
987 return -EBUSY;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200988 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 sg_build_reserve(sfp, val);
990 }
991 return 0;
992 case SG_GET_RESERVED_SIZE:
Alan Stern44ec9542007-02-20 11:01:57 -0500993 val = min_t(int, sfp->reserve.bufflen,
Akinobu Mita46f69e62014-06-02 22:56:46 +0900994 max_sectors_bytes(sdp->device->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 return put_user(val, ip);
996 case SG_SET_COMMAND_Q:
997 result = get_user(val, ip);
998 if (result)
999 return result;
1000 sfp->cmd_q = val ? 1 : 0;
1001 return 0;
1002 case SG_GET_COMMAND_Q:
1003 return put_user((int) sfp->cmd_q, ip);
1004 case SG_SET_KEEP_ORPHAN:
1005 result = get_user(val, ip);
1006 if (result)
1007 return result;
1008 sfp->keep_orphan = val;
1009 return 0;
1010 case SG_GET_KEEP_ORPHAN:
1011 return put_user((int) sfp->keep_orphan, ip);
1012 case SG_NEXT_CMD_LEN:
1013 result = get_user(val, ip);
1014 if (result)
1015 return result;
1016 sfp->next_cmd_len = (val > 0) ? val : 0;
1017 return 0;
1018 case SG_GET_VERSION_NUM:
1019 return put_user(sg_version_num, ip);
1020 case SG_GET_ACCESS_COUNT:
1021 /* faked - we don't have a real access count anymore */
1022 val = (sdp->device ? 1 : 0);
1023 return put_user(val, ip);
1024 case SG_GET_REQUEST_TABLE:
1025 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1026 return -EFAULT;
1027 else {
cb59e842005-04-02 13:51:23 -06001028 sg_req_info_t *rinfo;
1029 unsigned int ms;
1030
1031 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1032 GFP_KERNEL);
1033 if (!rinfo)
1034 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1036 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
1037 ++val, srp = srp ? srp->nextrp : srp) {
1038 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
1039 if (srp) {
1040 rinfo[val].req_state = srp->done + 1;
1041 rinfo[val].problem =
1042 srp->header.masked_status &
1043 srp->header.host_status &
1044 srp->header.driver_status;
cb59e842005-04-02 13:51:23 -06001045 if (srp->done)
1046 rinfo[val].duration =
1047 srp->header.duration;
1048 else {
1049 ms = jiffies_to_msecs(jiffies);
1050 rinfo[val].duration =
1051 (ms > srp->header.duration) ?
1052 (ms - srp->header.duration) : 0;
1053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 rinfo[val].orphan = srp->orphan;
cb59e842005-04-02 13:51:23 -06001055 rinfo[val].sg_io_owned =
1056 srp->sg_io_owned;
1057 rinfo[val].pack_id =
1058 srp->header.pack_id;
1059 rinfo[val].usr_ptr =
1060 srp->header.usr_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 }
1062 }
1063 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
cb59e842005-04-02 13:51:23 -06001064 result = __copy_to_user(p, rinfo,
1065 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1066 result = result ? -EFAULT : 0;
1067 kfree(rinfo);
1068 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 }
1070 case SG_EMULATED_HOST:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001071 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 return -ENODEV;
1073 return put_user(sdp->device->host->hostt->emulated, ip);
1074 case SG_SCSI_RESET:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001075 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 return -ENODEV;
1077 if (filp->f_flags & O_NONBLOCK) {
James Bottomley939647e2005-09-18 15:05:20 -05001078 if (scsi_host_in_recovery(sdp->device->host))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 return -EBUSY;
1080 } else if (!scsi_block_when_processing_errors(sdp->device))
1081 return -EBUSY;
1082 result = get_user(val, ip);
1083 if (result)
1084 return result;
1085 if (SG_SCSI_RESET_NOTHING == val)
1086 return 0;
1087 switch (val) {
1088 case SG_SCSI_RESET_DEVICE:
1089 val = SCSI_TRY_RESET_DEVICE;
1090 break;
Brian King39120e12008-07-01 13:03:19 -05001091 case SG_SCSI_RESET_TARGET:
1092 val = SCSI_TRY_RESET_TARGET;
1093 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 case SG_SCSI_RESET_BUS:
1095 val = SCSI_TRY_RESET_BUS;
1096 break;
1097 case SG_SCSI_RESET_HOST:
1098 val = SCSI_TRY_RESET_HOST;
1099 break;
1100 default:
1101 return -EINVAL;
1102 }
1103 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1104 return -EACCES;
1105 return (scsi_reset_provider(sdp->device, val) ==
1106 SUCCESS) ? 0 : -EIO;
1107 case SCSI_IOCTL_SEND_COMMAND:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001108 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 return -ENODEV;
1110 if (read_only) {
1111 unsigned char opcode = WRITE_6;
1112 Scsi_Ioctl_Command __user *siocp = p;
1113
1114 if (copy_from_user(&opcode, siocp->data, 1))
1115 return -EFAULT;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +09001116 if (sg_allow_access(filp, &opcode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 return -EPERM;
1118 }
Al Viroe915e872008-09-02 17:16:41 -04001119 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 case SG_SET_DEBUG:
1121 result = get_user(val, ip);
1122 if (result)
1123 return result;
1124 sdp->sgdebug = (char) val;
1125 return 0;
1126 case SCSI_IOCTL_GET_IDLUN:
1127 case SCSI_IOCTL_GET_BUS_NUMBER:
1128 case SCSI_IOCTL_PROBE_HOST:
1129 case SG_GET_TRANSFORM:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001130 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 return -ENODEV;
1132 return scsi_ioctl(sdp->device, cmd_in, p);
Alan Stern44ec9542007-02-20 11:01:57 -05001133 case BLKSECTGET:
Akinobu Mita46f69e62014-06-02 22:56:46 +09001134 return put_user(max_sectors_bytes(sdp->device->request_queue),
Alan Stern44ec9542007-02-20 11:01:57 -05001135 ip);
Christof Schmitt6da127a2008-01-11 10:09:43 +01001136 case BLKTRACESETUP:
1137 return blk_trace_setup(sdp->device->request_queue,
1138 sdp->disk->disk_name,
Martin Peschke76e3a192009-01-30 15:46:23 +01001139 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
Shawn Dud0deef52009-04-14 13:58:56 +08001140 NULL,
Christof Schmitt6da127a2008-01-11 10:09:43 +01001141 (char *)arg);
1142 case BLKTRACESTART:
1143 return blk_trace_startstop(sdp->device->request_queue, 1);
1144 case BLKTRACESTOP:
1145 return blk_trace_startstop(sdp->device->request_queue, 0);
1146 case BLKTRACETEARDOWN:
1147 return blk_trace_remove(sdp->device->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 default:
1149 if (read_only)
1150 return -EPERM; /* don't know so take safe approach */
1151 return scsi_ioctl(sdp->device, cmd_in, p);
1152 }
1153}
1154
1155#ifdef CONFIG_COMPAT
1156static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1157{
1158 Sg_device *sdp;
1159 Sg_fd *sfp;
1160 struct scsi_device *sdev;
1161
1162 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1163 return -ENXIO;
1164
1165 sdev = sdp->device;
1166 if (sdev->host->hostt->compat_ioctl) {
1167 int ret;
1168
1169 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1170
1171 return ret;
1172 }
1173
1174 return -ENOIOCTLCMD;
1175}
1176#endif
1177
1178static unsigned int
1179sg_poll(struct file *filp, poll_table * wait)
1180{
1181 unsigned int res = 0;
1182 Sg_device *sdp;
1183 Sg_fd *sfp;
1184 Sg_request *srp;
1185 int count = 0;
1186 unsigned long iflags;
1187
Jörn Engelebaf4662012-04-12 17:33:39 -04001188 sfp = filp->private_data;
1189 if (!sfp)
1190 return POLLERR;
1191 sdp = sfp->parentdp;
1192 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 return POLLERR;
1194 poll_wait(filp, &sfp->read_wait, wait);
1195 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1196 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1197 /* if any read waiting, flag it */
1198 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1199 res = POLLIN | POLLRDNORM;
1200 ++count;
1201 }
1202 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1203
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001204 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 res |= POLLHUP;
1206 else if (!sfp->cmd_q) {
1207 if (0 == count)
1208 res |= POLLOUT | POLLWRNORM;
1209 } else if (count < SG_MAX_QUEUE)
1210 res |= POLLOUT | POLLWRNORM;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001211 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1212 "sg_poll: res=0x%x\n", (int) res));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 return res;
1214}
1215
1216static int
1217sg_fasync(int fd, struct file *filp, int mode)
1218{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 Sg_device *sdp;
1220 Sg_fd *sfp;
1221
1222 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1223 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001224 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1225 "sg_fasync: mode=%d\n", mode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001227 return fasync_helper(fd, filp, mode, &sfp->async_qp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228}
1229
Nick Piggina13ff0b2008-02-07 18:46:06 -08001230static int
1231sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232{
1233 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001234 unsigned long offset, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001236 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
1238 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
Nick Piggina13ff0b2008-02-07 18:46:06 -08001239 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 rsv_schp = &sfp->reserve;
Nick Piggina13ff0b2008-02-07 18:46:06 -08001241 offset = vmf->pgoff << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 if (offset >= rsv_schp->bufflen)
Nick Piggina13ff0b2008-02-07 18:46:06 -08001243 return VM_FAULT_SIGBUS;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001244 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1245 "sg_vma_fault: offset=%lu, scatg=%d\n",
1246 offset, rsv_schp->k_use_sg));
Mike Christied6b10342005-11-08 04:06:41 -06001247 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001248 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1249 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001250 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001251 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001252 if (offset < len) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001253 struct page *page = nth_page(rsv_schp->pages[k],
1254 offset >> PAGE_SHIFT);
Mike Christied6b10342005-11-08 04:06:41 -06001255 get_page(page); /* increment page count */
Nick Piggina13ff0b2008-02-07 18:46:06 -08001256 vmf->page = page;
1257 return 0; /* success */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 }
Mike Christied6b10342005-11-08 04:06:41 -06001259 sa += len;
1260 offset -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 }
Mike Christied6b10342005-11-08 04:06:41 -06001262
Nick Piggina13ff0b2008-02-07 18:46:06 -08001263 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264}
1265
Alexey Dobriyanf0f37e22009-09-27 22:29:37 +04001266static const struct vm_operations_struct sg_mmap_vm_ops = {
Nick Piggina13ff0b2008-02-07 18:46:06 -08001267 .fault = sg_vma_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268};
1269
1270static int
1271sg_mmap(struct file *filp, struct vm_area_struct *vma)
1272{
1273 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001274 unsigned long req_sz, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001276 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
1278 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1279 return -ENXIO;
cb59e842005-04-02 13:51:23 -06001280 req_sz = vma->vm_end - vma->vm_start;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001281 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1282 "sg_mmap starting, vm_start=%p, len=%d\n",
1283 (void *) vma->vm_start, (int) req_sz));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 if (vma->vm_pgoff)
1285 return -EINVAL; /* want no offset */
1286 rsv_schp = &sfp->reserve;
1287 if (req_sz > rsv_schp->bufflen)
1288 return -ENOMEM; /* cannot map more than reserved buffer */
1289
Mike Christied6b10342005-11-08 04:06:41 -06001290 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001291 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1292 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001293 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001294 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001295 sa += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 }
Mike Christied6b10342005-11-08 04:06:41 -06001297
Nick Pigginf9aed0e2006-03-22 00:08:30 -08001298 sfp->mmap_called = 1;
Konstantin Khlebnikov314e51b2012-10-08 16:29:02 -07001299 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 vma->vm_private_data = sfp;
1301 vma->vm_ops = &sg_mmap_vm_ops;
1302 return 0;
1303}
1304
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001305static void
1306sg_rq_end_io_usercontext(struct work_struct *work)
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001307{
1308 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1309 struct sg_fd *sfp = srp->parentfp;
1310
1311 sg_finish_rem_req(srp);
1312 kref_put(&sfp->f_ref, sg_remove_sfp);
1313}
1314
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001315/*
1316 * This function is a "bottom half" handler that is called by the mid
1317 * level when a command is completed (or has failed).
1318 */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001319static void
1320sg_rq_end_io(struct request *rq, int uptodate)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321{
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001322 struct sg_request *srp = rq->end_io_data;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001323 Sg_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 unsigned long iflags;
cb59e842005-04-02 13:51:23 -06001326 unsigned int ms;
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001327 char *sense;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001328 int result, resid, done = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
Tony Battersbyc6517b792009-01-21 14:45:50 -05001330 if (WARN_ON(srp->done != 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001332
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 sfp = srp->parentfp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001334 if (WARN_ON(sfp == NULL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001336
1337 sdp = sfp->parentdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001338 if (unlikely(atomic_read(&sdp->detaching)))
1339 pr_info("%s: device detaching\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001341 sense = rq->sense;
1342 result = rq->errors;
Tejun Heoc3a4d782009-05-07 22:24:37 +09001343 resid = rq->resid_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001345 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1346 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1347 srp->header.pack_id, result));
Mike Christied6b10342005-11-08 04:06:41 -06001348 srp->header.resid = resid;
cb59e842005-04-02 13:51:23 -06001349 ms = jiffies_to_msecs(jiffies);
1350 srp->header.duration = (ms > srp->header.duration) ?
1351 (ms - srp->header.duration) : 0;
Mike Christied6b10342005-11-08 04:06:41 -06001352 if (0 != result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 struct scsi_sense_hdr sshdr;
1354
Mike Christied6b10342005-11-08 04:06:41 -06001355 srp->header.status = 0xff & result;
1356 srp->header.masked_status = status_byte(result);
1357 srp->header.msg_status = msg_byte(result);
1358 srp->header.host_status = host_byte(result);
1359 srp->header.driver_status = driver_byte(result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 if ((sdp->sgdebug > 0) &&
1361 ((CHECK_CONDITION == srp->header.masked_status) ||
1362 (COMMAND_TERMINATED == srp->header.masked_status)))
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001363 __scsi_print_sense(__func__, sense,
Mike Christied6b10342005-11-08 04:06:41 -06001364 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
1366 /* Following if statement is a patch supplied by Eric Youngdale */
Mike Christied6b10342005-11-08 04:06:41 -06001367 if (driver_byte(result) != 0
1368 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 && !scsi_sense_is_deferred(&sshdr)
1370 && sshdr.sense_key == UNIT_ATTENTION
1371 && sdp->device->removable) {
1372 /* Detected possible disc change. Set the bit - this */
1373 /* may be used if there are filesystems using this device */
1374 sdp->device->changed = 1;
1375 }
1376 }
1377 /* Rely on write phase to clean out srp status values, so no "else" */
1378
Tony Battersbyc6517b792009-01-21 14:45:50 -05001379 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1380 if (unlikely(srp->orphan)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 if (sfp->keep_orphan)
1382 srp->sg_io_owned = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001383 else
1384 done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001386 srp->done = done;
1387 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1388
1389 if (likely(done)) {
1390 /* Now wake up any sg_read() that is waiting for this
1391 * packet.
1392 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 wake_up_interruptible(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001394 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001395 kref_put(&sfp->f_ref, sg_remove_sfp);
FUJITA Tomonori015640e2009-04-03 19:28:06 +09001396 } else {
1397 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1398 schedule_work(&srp->ew.work);
1399 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400}
1401
Alexey Dobriyan828c0952009-10-01 15:43:56 -07001402static const struct file_operations sg_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 .owner = THIS_MODULE,
1404 .read = sg_read,
1405 .write = sg_write,
1406 .poll = sg_poll,
Jörn Engel37b9d1e2012-04-12 17:35:05 -04001407 .unlocked_ioctl = sg_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408#ifdef CONFIG_COMPAT
1409 .compat_ioctl = sg_compat_ioctl,
1410#endif
1411 .open = sg_open,
1412 .mmap = sg_mmap,
1413 .release = sg_release,
1414 .fasync = sg_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001415 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416};
1417
gregkh@suse.ded2538782005-03-23 09:55:22 -08001418static struct class *sg_sysfs_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
1420static int sg_sysfs_valid = 0;
1421
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001422static Sg_device *
1423sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424{
Mike Christied6b10342005-11-08 04:06:41 -06001425 struct request_queue *q = scsidp->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 Sg_device *sdp;
1427 unsigned long iflags;
James Bottomley7c07d612007-08-05 13:36:11 -05001428 int error;
1429 u32 k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
Jes Sorensen24669f752006-01-16 10:31:18 -05001431 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 if (!sdp) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001433 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1434 "failure\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001435 return ERR_PTR(-ENOMEM);
1436 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001437
Tejun Heob98c52b2013-02-27 17:04:42 -08001438 idr_preload(GFP_KERNEL);
James Bottomley7c07d612007-08-05 13:36:11 -05001439 write_lock_irqsave(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Tejun Heob98c52b2013-02-27 17:04:42 -08001441 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1442 if (error < 0) {
1443 if (error == -ENOSPC) {
1444 sdev_printk(KERN_WARNING, scsidp,
1445 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1446 scsidp->type, SG_MAX_DEVS - 1);
1447 error = -ENODEV;
1448 } else {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001449 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1450 "allocation Sg_device failure: %d\n",
1451 __func__, error);
Tejun Heob98c52b2013-02-27 17:04:42 -08001452 }
1453 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 }
Tejun Heob98c52b2013-02-27 17:04:42 -08001455 k = error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001457 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1458 "sg_alloc: dev=%d \n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 sprintf(disk->disk_name, "sg%d", k);
1460 disk->first_minor = k;
1461 sdp->disk = disk;
1462 sdp->device = scsidp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001463 mutex_init(&sdp->open_rel_lock);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001464 INIT_LIST_HEAD(&sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001465 init_waitqueue_head(&sdp->open_wait);
1466 atomic_set(&sdp->detaching, 0);
1467 rwlock_init(&sdp->sfd_lock);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001468 sdp->sg_tablesize = queue_max_segments(q);
James Bottomley7c07d612007-08-05 13:36:11 -05001469 sdp->index = k;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001470 kref_init(&sdp->d_ref);
James Bottomley7c07d612007-08-05 13:36:11 -05001471 error = 0;
Tejun Heob98c52b2013-02-27 17:04:42 -08001472
1473out_unlock:
1474 write_unlock_irqrestore(&sg_index_lock, iflags);
1475 idr_preload_end();
1476
James Bottomley7c07d612007-08-05 13:36:11 -05001477 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 kfree(sdp);
James Bottomley7c07d612007-08-05 13:36:11 -05001479 return ERR_PTR(error);
1480 }
1481 return sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482}
1483
1484static int
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001485sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486{
Tony Jonesee959b02008-02-22 00:13:36 +01001487 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 struct gendisk *disk;
1489 Sg_device *sdp = NULL;
1490 struct cdev * cdev = NULL;
James Bottomley7c07d612007-08-05 13:36:11 -05001491 int error;
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001492 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
1494 disk = alloc_disk(1);
1495 if (!disk) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001496 pr_warn("%s: alloc_disk failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 return -ENOMEM;
1498 }
1499 disk->major = SCSI_GENERIC_MAJOR;
1500
1501 error = -ENOMEM;
1502 cdev = cdev_alloc();
1503 if (!cdev) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001504 pr_warn("%s: cdev_alloc failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 goto out;
1506 }
1507 cdev->owner = THIS_MODULE;
1508 cdev->ops = &sg_fops;
1509
James Bottomley7c07d612007-08-05 13:36:11 -05001510 sdp = sg_alloc(disk, scsidp);
1511 if (IS_ERR(sdp)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001512 pr_warn("%s: sg_alloc failed\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001513 error = PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 goto out;
1515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
James Bottomley7c07d612007-08-05 13:36:11 -05001517 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
Greg KH5e3c34c2006-01-18 16:17:46 -08001518 if (error)
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001519 goto cdev_add_err;
Greg KH5e3c34c2006-01-18 16:17:46 -08001520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 sdp->cdev = cdev;
1522 if (sg_sysfs_valid) {
Tony Jonesee959b02008-02-22 00:13:36 +01001523 struct device *sg_class_member;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
Greg Kroah-Hartmand73a1a62008-07-21 20:03:34 -07001525 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1526 MKDEV(SCSI_GENERIC_MAJOR,
1527 sdp->index),
1528 sdp, "%s", disk->disk_name);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001529 if (IS_ERR(sg_class_member)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001530 pr_err("%s: device_create failed\n", __func__);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001531 error = PTR_ERR(sg_class_member);
1532 goto cdev_add_err;
1533 }
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001534 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 &sg_class_member->kobj, "generic");
1536 if (error)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001537 pr_err("%s: unable to make symlink 'generic' back "
1538 "to sg%d\n", __func__, sdp->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 } else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001540 pr_warn("%s: sg_sys Invalid\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001542 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1543 "type %d\n", sdp->index, scsidp->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
Tony Jonesee959b02008-02-22 00:13:36 +01001545 dev_set_drvdata(cl_dev, sdp);
FUJITA Tomonoria24484f2008-01-15 13:17:47 +09001546
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 return 0;
1548
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001549cdev_add_err:
James Bottomley7c07d612007-08-05 13:36:11 -05001550 write_lock_irqsave(&sg_index_lock, iflags);
1551 idr_remove(&sg_index_idr, sdp->index);
1552 write_unlock_irqrestore(&sg_index_lock, iflags);
1553 kfree(sdp);
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001554
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555out:
1556 put_disk(disk);
1557 if (cdev)
1558 cdev_del(cdev);
1559 return error;
1560}
1561
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001562static void
1563sg_device_destroy(struct kref *kref)
Tony Battersbyc6517b792009-01-21 14:45:50 -05001564{
1565 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1566 unsigned long flags;
1567
1568 /* CAUTION! Note that the device can still be found via idr_find()
1569 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1570 * any other cleanup.
1571 */
1572
1573 write_lock_irqsave(&sg_index_lock, flags);
1574 idr_remove(&sg_index_idr, sdp->index);
1575 write_unlock_irqrestore(&sg_index_lock, flags);
1576
1577 SCSI_LOG_TIMEOUT(3,
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001578 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001579
1580 put_disk(sdp->disk);
1581 kfree(sdp);
1582}
1583
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001584static void
1585sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586{
Tony Jonesee959b02008-02-22 00:13:36 +01001587 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1588 Sg_device *sdp = dev_get_drvdata(cl_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 unsigned long iflags;
1590 Sg_fd *sfp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001591 int val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001593 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 return;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001595 /* want sdp->detaching non-zero as soon as possible */
1596 val = atomic_inc_return(&sdp->detaching);
1597 if (val > 1)
1598 return; /* only want to do following once per device */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001600 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1601 "%s\n", __func__));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001602
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001603 read_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001604 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001605 wake_up_interruptible_all(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001606 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001608 wake_up_interruptible_all(&sdp->open_wait);
1609 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
James Bottomley7c07d612007-08-05 13:36:11 -05001610
1611 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
Tony Jonesee959b02008-02-22 00:13:36 +01001612 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
James Bottomley7c07d612007-08-05 13:36:11 -05001613 cdev_del(sdp->cdev);
1614 sdp->cdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001616 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617}
1618
Douglas Gilbert6460e752006-09-20 18:20:49 -04001619module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1620module_param_named(def_reserved_size, def_reserved_size, int,
1621 S_IRUGO | S_IWUSR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1623
1624MODULE_AUTHOR("Douglas Gilbert");
1625MODULE_DESCRIPTION("SCSI generic (sg) driver");
1626MODULE_LICENSE("GPL");
1627MODULE_VERSION(SG_VERSION_STR);
Rene Hermanf018fa52006-03-08 00:14:20 -08001628MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Douglas Gilbert6460e752006-09-20 18:20:49 -04001630MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1631 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1633MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1634
1635static int __init
1636init_sg(void)
1637{
1638 int rc;
1639
Douglas Gilbert6460e752006-09-20 18:20:49 -04001640 if (scatter_elem_sz < PAGE_SIZE) {
1641 scatter_elem_sz = PAGE_SIZE;
1642 scatter_elem_sz_prev = scatter_elem_sz;
1643 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 if (def_reserved_size >= 0)
1645 sg_big_buff = def_reserved_size;
Douglas Gilbert6460e752006-09-20 18:20:49 -04001646 else
1647 def_reserved_size = sg_big_buff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
1649 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1650 SG_MAX_DEVS, "sg");
1651 if (rc)
1652 return rc;
gregkh@suse.ded2538782005-03-23 09:55:22 -08001653 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 if ( IS_ERR(sg_sysfs_class) ) {
1655 rc = PTR_ERR(sg_sysfs_class);
1656 goto err_out;
1657 }
1658 sg_sysfs_valid = 1;
1659 rc = scsi_register_interface(&sg_interface);
1660 if (0 == rc) {
1661#ifdef CONFIG_SCSI_PROC_FS
1662 sg_proc_init();
1663#endif /* CONFIG_SCSI_PROC_FS */
1664 return 0;
1665 }
gregkh@suse.ded2538782005-03-23 09:55:22 -08001666 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667err_out:
1668 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1669 return rc;
1670}
1671
1672static void __exit
1673exit_sg(void)
1674{
1675#ifdef CONFIG_SCSI_PROC_FS
1676 sg_proc_cleanup();
1677#endif /* CONFIG_SCSI_PROC_FS */
1678 scsi_unregister_interface(&sg_interface);
gregkh@suse.ded2538782005-03-23 09:55:22 -08001679 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 sg_sysfs_valid = 0;
1681 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1682 SG_MAX_DEVS);
James Bottomley7c07d612007-08-05 13:36:11 -05001683 idr_destroy(&sg_index_idr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684}
1685
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001686static int
1687sg_start_req(Sg_request *srp, unsigned char *cmd)
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001688{
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001689 int res;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001690 struct request *rq;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001691 Sg_fd *sfp = srp->parentfp;
1692 sg_io_hdr_t *hp = &srp->header;
1693 int dxfer_len = (int) hp->dxfer_len;
1694 int dxfer_dir = hp->dxfer_direction;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001695 unsigned int iov_count = hp->iovec_count;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001696 Sg_scatter_hold *req_schp = &srp->data;
1697 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1698 struct request_queue *q = sfp->parentdp->device->request_queue;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001699 struct rq_map_data *md, map_data;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001700 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001701 unsigned char *long_cmdp = NULL;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001702
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001703 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1704 "sg_start_req: dxfer_len=%d\n",
1705 dxfer_len));
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001706
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001707 if (hp->cmd_len > BLK_MAX_CDB) {
1708 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1709 if (!long_cmdp)
1710 return -ENOMEM;
1711 }
1712
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001713 rq = blk_get_request(q, rw, GFP_ATOMIC);
Joe Lawrencea492f072014-08-28 08:15:21 -06001714 if (IS_ERR(rq)) {
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001715 kfree(long_cmdp);
Joe Lawrencea492f072014-08-28 08:15:21 -06001716 return PTR_ERR(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001717 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001718
Jens Axboef27b0872014-06-06 07:57:37 -06001719 blk_rq_set_block_pc(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001720
1721 if (hp->cmd_len > BLK_MAX_CDB)
1722 rq->cmd = long_cmdp;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001723 memcpy(rq->cmd, cmd, hp->cmd_len);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001724 rq->cmd_len = hp->cmd_len;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001725
1726 srp->rq = rq;
1727 rq->end_io_data = srp;
1728 rq->sense = srp->sense_b;
1729 rq->retries = SG_DEFAULT_RETRIES;
1730
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001732 return 0;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001733
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001734 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1735 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1736 !sfp->parentdp->device->host->unchecked_isa_dma &&
Namhyung Kim2610a252010-09-16 12:55:57 +09001737 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001738 md = NULL;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001739 else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001740 md = &map_data;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001741
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001742 if (md) {
1743 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1744 sg_link_reserve(sfp, srp, dxfer_len);
1745 else {
1746 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1747 if (res)
1748 return res;
1749 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001750
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001751 md->pages = req_schp->pages;
1752 md->page_order = req_schp->page_order;
1753 md->nr_entries = req_schp->k_use_sg;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001754 md->offset = 0;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +09001755 md->null_mapped = hp->dxferp ? 0 : 1;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001756 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1757 md->from_user = 1;
1758 else
1759 md->from_user = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001761
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001762 if (iov_count) {
1763 int len, size = sizeof(struct sg_iovec) * iov_count;
1764 struct iovec *iov;
1765
Julia Lawall30941412010-08-10 18:01:27 -07001766 iov = memdup_user(hp->dxferp, size);
1767 if (IS_ERR(iov))
1768 return PTR_ERR(iov);
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001769
1770 len = iov_length(iov, iov_count);
1771 if (hp->dxfer_len < len) {
1772 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1773 len = hp->dxfer_len;
1774 }
1775
1776 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1777 iov_count,
1778 len, GFP_ATOMIC);
1779 kfree(iov);
1780 } else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001781 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1782 hp->dxfer_len, GFP_ATOMIC);
1783
1784 if (!res) {
1785 srp->bio = rq->bio;
1786
1787 if (!md) {
1788 req_schp->dio_in_use = 1;
1789 hp->info |= SG_INFO_DIRECT_IO;
1790 }
1791 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001792 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793}
1794
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001795static int
1796sg_finish_rem_req(Sg_request *srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797{
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001798 int ret = 0;
1799
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 Sg_fd *sfp = srp->parentfp;
1801 Sg_scatter_hold *req_schp = &srp->data;
1802
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001803 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1804 "sg_finish_rem_req: res_used=%d\n",
1805 (int) srp->res_used));
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001806 if (srp->rq) {
1807 if (srp->bio)
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001808 ret = blk_rq_unmap_user(srp->bio);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001809
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001810 if (srp->rq->cmd != srp->rq->__cmd)
1811 kfree(srp->rq->cmd);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001812 blk_put_request(srp->rq);
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001813 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001814
Christof Schmitte27168f2009-09-17 09:10:14 +02001815 if (srp->res_used)
1816 sg_unlink_reserve(sfp, srp);
1817 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001818 sg_remove_scat(sfp, req_schp);
Christof Schmitte27168f2009-09-17 09:10:14 +02001819
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 sg_remove_request(sfp, srp);
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001821
1822 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823}
1824
1825static int
1826sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1827{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001828 int sg_bufflen = tablesize * sizeof(struct page *);
Al Viro2d20eaf2006-02-01 06:31:40 -05001829 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001831 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1832 if (!schp->pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 schp->sglist_len = sg_bufflen;
Mike Christied6b10342005-11-08 04:06:41 -06001835 return tablesize; /* number of scat_gath elements allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836}
1837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838static int
1839sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1840{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001841 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
Mike Christied6b10342005-11-08 04:06:41 -06001842 int sg_tablesize = sfp->parentdp->sg_tablesize;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001843 int blk_size = buff_size, order;
1844 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
Eric Sesterhennfb119932007-05-23 14:41:36 -07001846 if (blk_size < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 return -EFAULT;
1848 if (0 == blk_size)
1849 ++blk_size; /* don't know why */
FUJITA Tomonorib2ed6c62009-02-12 02:42:57 +09001850 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1851 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001852 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1853 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1854 buff_size, blk_size));
Mike Christied6b10342005-11-08 04:06:41 -06001855
1856 /* N.B. ret_sz carried into this block ... */
1857 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1858 if (mx_sc_elems < 0)
1859 return mx_sc_elems; /* most likely -ENOMEM */
1860
Douglas Gilbert6460e752006-09-20 18:20:49 -04001861 num = scatter_elem_sz;
1862 if (unlikely(num != scatter_elem_sz_prev)) {
1863 if (num < PAGE_SIZE) {
1864 scatter_elem_sz = PAGE_SIZE;
1865 scatter_elem_sz_prev = PAGE_SIZE;
1866 } else
1867 scatter_elem_sz_prev = num;
1868 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001869
1870 if (sfp->low_dma)
1871 gfp_mask |= GFP_DMA;
1872
1873 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1874 gfp_mask |= __GFP_ZERO;
1875
1876 order = get_order(num);
1877retry:
1878 ret_sz = 1 << (PAGE_SHIFT + order);
1879
1880 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1881 k++, rem_sz -= ret_sz) {
1882
Douglas Gilbert6460e752006-09-20 18:20:49 -04001883 num = (rem_sz > scatter_elem_sz_prev) ?
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001884 scatter_elem_sz_prev : rem_sz;
1885
1886 schp->pages[k] = alloc_pages(gfp_mask, order);
1887 if (!schp->pages[k])
1888 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
Douglas Gilbert6460e752006-09-20 18:20:49 -04001890 if (num == scatter_elem_sz_prev) {
1891 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1892 scatter_elem_sz = ret_sz;
1893 scatter_elem_sz_prev = ret_sz;
1894 }
1895 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001897 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1898 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1899 k, num, ret_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001900 } /* end of for loop */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001902 schp->page_order = order;
Mike Christied6b10342005-11-08 04:06:41 -06001903 schp->k_use_sg = k;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001904 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1905 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1906 k, rem_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001907
1908 schp->bufflen = blk_size;
1909 if (rem_sz > 0) /* must have failed */
1910 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 return 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001912out:
1913 for (i = 0; i < k; i++)
Michal Schmidte71044e2009-09-03 14:27:08 +02001914 __free_pages(schp->pages[i], order);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001915
1916 if (--order >= 0)
1917 goto retry;
1918
1919 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920}
1921
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922static void
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001923sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924{
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001925 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1926 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001927 if (schp->pages && schp->sglist_len > 0) {
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001928 if (!schp->dio_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 int k;
1930
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001931 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001932 SCSI_LOG_TIMEOUT(5,
1933 sg_printk(KERN_INFO, sfp->parentdp,
1934 "sg_remove_scat: k=%d, pg=0x%p\n",
1935 k, schp->pages[k]));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001936 __free_pages(schp->pages[k], schp->page_order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 }
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001938
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001939 kfree(schp->pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 }
Mike Christied6b10342005-11-08 04:06:41 -06001941 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 memset(schp, 0, sizeof (*schp));
1943}
1944
1945static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1947{
1948 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06001949 int k, num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001951 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1952 "sg_read_oxfer: num_read_xfer=%d\n",
1953 num_read_xfer));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 if ((!outp) || (num_read_xfer <= 0))
1955 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001957 num = 1 << (PAGE_SHIFT + schp->page_order);
1958 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001959 if (num > num_read_xfer) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001960 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001961 num_read_xfer))
1962 return -EFAULT;
1963 break;
1964 } else {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001965 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001966 num))
1967 return -EFAULT;
1968 num_read_xfer -= num;
1969 if (num_read_xfer <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 break;
Mike Christied6b10342005-11-08 04:06:41 -06001971 outp += num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 }
Mike Christied6b10342005-11-08 04:06:41 -06001974
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 return 0;
1976}
1977
1978static void
1979sg_build_reserve(Sg_fd * sfp, int req_size)
1980{
1981 Sg_scatter_hold *schp = &sfp->reserve;
1982
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001983 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1984 "sg_build_reserve: req_size=%d\n", req_size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 do {
1986 if (req_size < PAGE_SIZE)
1987 req_size = PAGE_SIZE;
1988 if (0 == sg_build_indirect(schp, sfp, req_size))
1989 return;
1990 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001991 sg_remove_scat(sfp, schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 req_size >>= 1; /* divide by 2 */
1993 } while (req_size > (PAGE_SIZE / 2));
1994}
1995
1996static void
1997sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1998{
1999 Sg_scatter_hold *req_schp = &srp->data;
2000 Sg_scatter_hold *rsv_schp = &sfp->reserve;
Mike Christied6b10342005-11-08 04:06:41 -06002001 int k, num, rem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002
2003 srp->res_used = 1;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002004 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2005 "sg_link_reserve: size=%d\n", size));
Brian Kingeca7be52006-02-14 12:42:24 -06002006 rem = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002008 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2009 for (k = 0; k < rsv_schp->k_use_sg; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06002010 if (rem <= num) {
Mike Christied6b10342005-11-08 04:06:41 -06002011 req_schp->k_use_sg = k + 1;
2012 req_schp->sglist_len = rsv_schp->sglist_len;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002013 req_schp->pages = rsv_schp->pages;
Mike Christied6b10342005-11-08 04:06:41 -06002014
2015 req_schp->bufflen = size;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002016 req_schp->page_order = rsv_schp->page_order;
Mike Christied6b10342005-11-08 04:06:41 -06002017 break;
2018 } else
2019 rem -= num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 }
Mike Christied6b10342005-11-08 04:06:41 -06002021
2022 if (k >= rsv_schp->k_use_sg)
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002023 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2024 "sg_link_reserve: BAD size\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025}
2026
2027static void
2028sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2029{
2030 Sg_scatter_hold *req_schp = &srp->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002032 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2033 "sg_unlink_reserve: req->k_use_sg=%d\n",
2034 (int) req_schp->k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 req_schp->k_use_sg = 0;
2036 req_schp->bufflen = 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002037 req_schp->pages = NULL;
2038 req_schp->page_order = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 req_schp->sglist_len = 0;
2040 sfp->save_scat_len = 0;
2041 srp->res_used = 0;
2042}
2043
2044static Sg_request *
2045sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2046{
2047 Sg_request *resp;
2048 unsigned long iflags;
2049
2050 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2051 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2052 /* look for requests that are ready + not SG_IO owned */
2053 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2054 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2055 resp->done = 2; /* guard against other readers */
2056 break;
2057 }
2058 }
2059 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2060 return resp;
2061}
2062
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063/* always adds to end of list */
2064static Sg_request *
2065sg_add_request(Sg_fd * sfp)
2066{
2067 int k;
2068 unsigned long iflags;
2069 Sg_request *resp;
2070 Sg_request *rp = sfp->req_arr;
2071
2072 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2073 resp = sfp->headrp;
2074 if (!resp) {
2075 memset(rp, 0, sizeof (Sg_request));
2076 rp->parentfp = sfp;
2077 resp = rp;
2078 sfp->headrp = resp;
2079 } else {
2080 if (0 == sfp->cmd_q)
2081 resp = NULL; /* command queuing disallowed */
2082 else {
2083 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2084 if (!rp->parentfp)
2085 break;
2086 }
2087 if (k < SG_MAX_QUEUE) {
2088 memset(rp, 0, sizeof (Sg_request));
2089 rp->parentfp = sfp;
2090 while (resp->nextrp)
2091 resp = resp->nextrp;
2092 resp->nextrp = rp;
2093 resp = rp;
2094 } else
2095 resp = NULL;
2096 }
2097 }
2098 if (resp) {
2099 resp->nextrp = NULL;
cb59e842005-04-02 13:51:23 -06002100 resp->header.duration = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 }
2102 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2103 return resp;
2104}
2105
2106/* Return of 1 for found; 0 for not found */
2107static int
2108sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2109{
2110 Sg_request *prev_rp;
2111 Sg_request *rp;
2112 unsigned long iflags;
2113 int res = 0;
2114
2115 if ((!sfp) || (!srp) || (!sfp->headrp))
2116 return res;
2117 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2118 prev_rp = sfp->headrp;
2119 if (srp == prev_rp) {
2120 sfp->headrp = prev_rp->nextrp;
2121 prev_rp->parentfp = NULL;
2122 res = 1;
2123 } else {
2124 while ((rp = prev_rp->nextrp)) {
2125 if (srp == rp) {
2126 prev_rp->nextrp = rp->nextrp;
2127 rp->parentfp = NULL;
2128 res = 1;
2129 break;
2130 }
2131 prev_rp = rp;
2132 }
2133 }
2134 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2135 return res;
2136}
2137
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138static Sg_fd *
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002139sg_add_sfp(Sg_device * sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140{
2141 Sg_fd *sfp;
2142 unsigned long iflags;
Alan Stern44ec9542007-02-20 11:01:57 -05002143 int bufflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144
Mike Christied6b10342005-11-08 04:06:41 -06002145 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 if (!sfp)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002147 return ERR_PTR(-ENOMEM);
Mike Christied6b10342005-11-08 04:06:41 -06002148
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 init_waitqueue_head(&sfp->read_wait);
2150 rwlock_init(&sfp->rq_list_lock);
2151
Tony Battersbyc6517b792009-01-21 14:45:50 -05002152 kref_init(&sfp->f_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 sfp->timeout = SG_DEFAULT_TIMEOUT;
2154 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2155 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2156 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2157 sdp->device->host->unchecked_isa_dma : 1;
2158 sfp->cmd_q = SG_DEF_COMMAND_Q;
2159 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2160 sfp->parentdp = sdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002161 write_lock_irqsave(&sdp->sfd_lock, iflags);
2162 if (atomic_read(&sdp->detaching)) {
2163 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2164 return ERR_PTR(-ENODEV);
2165 }
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002166 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002167 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002168 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2169 "sg_add_sfp: sfp=0x%p\n", sfp));
Douglas Gilbert6460e752006-09-20 18:20:49 -04002170 if (unlikely(sg_big_buff != def_reserved_size))
2171 sg_big_buff = def_reserved_size;
2172
Alan Stern44ec9542007-02-20 11:01:57 -05002173 bufflen = min_t(int, sg_big_buff,
Akinobu Mita46f69e62014-06-02 22:56:46 +09002174 max_sectors_bytes(sdp->device->request_queue));
Alan Stern44ec9542007-02-20 11:01:57 -05002175 sg_build_reserve(sfp, bufflen);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002176 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2177 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2178 sfp->reserve.bufflen,
2179 sfp->reserve.k_use_sg));
Tony Battersbyc6517b792009-01-21 14:45:50 -05002180
2181 kref_get(&sdp->d_ref);
2182 __module_get(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 return sfp;
2184}
2185
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002186static void
2187sg_remove_sfp_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002189 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2190 struct sg_device *sdp = sfp->parentdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
Tony Battersbyc6517b792009-01-21 14:45:50 -05002192 /* Cleanup any responses which were never read(). */
2193 while (sfp->headrp)
2194 sg_finish_rem_req(sfp->headrp);
2195
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 if (sfp->reserve.bufflen > 0) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002197 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2198 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
Tony Battersbyc6517b792009-01-21 14:45:50 -05002199 (int) sfp->reserve.bufflen,
2200 (int) sfp->reserve.k_use_sg));
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002201 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002203
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002204 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2205 "sg_remove_sfp: sfp=0x%p\n", sfp));
Mike Christied6b10342005-11-08 04:06:41 -06002206 kfree(sfp);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002207
2208 scsi_device_put(sdp->device);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002209 kref_put(&sdp->d_ref, sg_device_destroy);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002210 module_put(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211}
2212
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002213static void
2214sg_remove_sfp(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002216 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
James Bottomley065b4a22013-10-25 10:27:02 +01002217 struct sg_device *sdp = sfp->parentdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002218 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002220 write_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002221 list_del(&sfp->sfd_siblings);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002222 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
FUJITA Tomonori015640e2009-04-03 19:28:06 +09002224 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2225 schedule_work(&sfp->ew.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226}
2227
2228static int
2229sg_res_in_use(Sg_fd * sfp)
2230{
2231 const Sg_request *srp;
2232 unsigned long iflags;
2233
2234 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2235 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2236 if (srp->res_used)
2237 break;
2238 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2239 return srp ? 1 : 0;
2240}
2241
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242#ifdef CONFIG_SCSI_PROC_FS
2243static int
James Bottomley7c07d612007-08-05 13:36:11 -05002244sg_idr_max_id(int id, void *p, void *data)
2245{
2246 int *k = data;
2247
2248 if (*k < id)
2249 *k = id;
2250
2251 return 0;
2252}
2253
2254static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255sg_last_dev(void)
2256{
Tony Battersby53474c02008-01-22 15:25:49 -05002257 int k = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 unsigned long iflags;
2259
James Bottomley7c07d612007-08-05 13:36:11 -05002260 read_lock_irqsave(&sg_index_lock, iflags);
2261 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2262 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 return k + 1; /* origin 1 */
2264}
2265#endif
2266
Tony Battersbyc6517b792009-01-21 14:45:50 -05002267/* must be called with sg_index_lock held */
2268static Sg_device *sg_lookup_dev(int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002270 return idr_find(&sg_index_idr, dev);
2271}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002273static Sg_device *
2274sg_get_dev(int dev)
Tony Battersbyc6517b792009-01-21 14:45:50 -05002275{
2276 struct sg_device *sdp;
2277 unsigned long flags;
2278
2279 read_lock_irqsave(&sg_index_lock, flags);
2280 sdp = sg_lookup_dev(dev);
2281 if (!sdp)
2282 sdp = ERR_PTR(-ENXIO);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002283 else if (atomic_read(&sdp->detaching)) {
2284 /* If sdp->detaching, then the refcount may already be 0, in
Tony Battersbyc6517b792009-01-21 14:45:50 -05002285 * which case it would be a bug to do kref_get().
2286 */
2287 sdp = ERR_PTR(-ENODEV);
2288 } else
2289 kref_get(&sdp->d_ref);
2290 read_unlock_irqrestore(&sg_index_lock, flags);
James Bottomley7c07d612007-08-05 13:36:11 -05002291
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 return sdp;
2293}
2294
2295#ifdef CONFIG_SCSI_PROC_FS
2296
2297static struct proc_dir_entry *sg_proc_sgp = NULL;
2298
2299static char sg_proc_sg_dirname[] = "scsi/sg";
2300
2301static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2302
2303static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2304static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2305 size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002306static const struct file_operations adio_fops = {
2307 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 .open = sg_proc_single_open_adio,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002309 .read = seq_read,
2310 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311 .write = sg_proc_write_adio,
2312 .release = single_release,
2313};
2314
2315static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2316static ssize_t sg_proc_write_dressz(struct file *filp,
2317 const char __user *buffer, size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002318static const struct file_operations dressz_fops = {
2319 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 .open = sg_proc_single_open_dressz,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002321 .read = seq_read,
2322 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 .write = sg_proc_write_dressz,
2324 .release = single_release,
2325};
2326
2327static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2328static int sg_proc_single_open_version(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002329static const struct file_operations version_fops = {
2330 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 .open = sg_proc_single_open_version,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002332 .read = seq_read,
2333 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 .release = single_release,
2335};
2336
2337static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2338static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002339static const struct file_operations devhdr_fops = {
2340 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 .open = sg_proc_single_open_devhdr,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002342 .read = seq_read,
2343 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 .release = single_release,
2345};
2346
2347static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2348static int sg_proc_open_dev(struct inode *inode, struct file *file);
2349static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2350static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2351static void dev_seq_stop(struct seq_file *s, void *v);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002352static const struct file_operations dev_fops = {
2353 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 .open = sg_proc_open_dev,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002355 .read = seq_read,
2356 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 .release = seq_release,
2358};
James Morris88e9d342009-09-22 16:43:43 -07002359static const struct seq_operations dev_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 .start = dev_seq_start,
2361 .next = dev_seq_next,
2362 .stop = dev_seq_stop,
2363 .show = sg_proc_seq_show_dev,
2364};
2365
2366static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2367static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002368static const struct file_operations devstrs_fops = {
2369 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 .open = sg_proc_open_devstrs,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002371 .read = seq_read,
2372 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 .release = seq_release,
2374};
James Morris88e9d342009-09-22 16:43:43 -07002375static const struct seq_operations devstrs_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 .start = dev_seq_start,
2377 .next = dev_seq_next,
2378 .stop = dev_seq_stop,
2379 .show = sg_proc_seq_show_devstrs,
2380};
2381
2382static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2383static int sg_proc_open_debug(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002384static const struct file_operations debug_fops = {
2385 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 .open = sg_proc_open_debug,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002387 .read = seq_read,
2388 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 .release = seq_release,
2390};
James Morris88e9d342009-09-22 16:43:43 -07002391static const struct seq_operations debug_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 .start = dev_seq_start,
2393 .next = dev_seq_next,
2394 .stop = dev_seq_stop,
2395 .show = sg_proc_seq_show_debug,
2396};
2397
2398
2399struct sg_proc_leaf {
2400 const char * name;
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002401 const struct file_operations * fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402};
2403
Jörn Engel18b8ba62012-04-12 17:35:25 -04002404static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 {"allow_dio", &adio_fops},
2406 {"debug", &debug_fops},
2407 {"def_reserved_size", &dressz_fops},
2408 {"device_hdr", &devhdr_fops},
2409 {"devices", &dev_fops},
2410 {"device_strs", &devstrs_fops},
2411 {"version", &version_fops}
2412};
2413
2414static int
2415sg_proc_init(void)
2416{
Tobias Klauser6391a112006-06-08 22:23:48 -07002417 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Al Virod161a132011-07-24 03:36:29 -04002418 int k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419
Al Viro66600222005-09-28 22:32:57 +01002420 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 if (!sg_proc_sgp)
2422 return 1;
2423 for (k = 0; k < num_leaves; ++k) {
Jörn Engel18b8ba62012-04-12 17:35:25 -04002424 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
Al Virod161a132011-07-24 03:36:29 -04002425 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
Denis V. Luneva9739092008-04-29 01:02:17 -07002426 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 }
2428 return 0;
2429}
2430
2431static void
2432sg_proc_cleanup(void)
2433{
2434 int k;
Tobias Klauser6391a112006-06-08 22:23:48 -07002435 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
2437 if (!sg_proc_sgp)
2438 return;
2439 for (k = 0; k < num_leaves; ++k)
2440 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2441 remove_proc_entry(sg_proc_sg_dirname, NULL);
2442}
2443
2444
2445static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2446{
2447 seq_printf(s, "%d\n", *((int *)s->private));
2448 return 0;
2449}
2450
2451static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2452{
2453 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2454}
2455
2456static ssize_t
2457sg_proc_write_adio(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;
2461 unsigned long num;
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 err = kstrtoul_from_user(buffer, count, 0, &num);
2466 if (err)
2467 return err;
2468 sg_allow_dio = num ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 return count;
2470}
2471
2472static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2473{
2474 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2475}
2476
2477static ssize_t
2478sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2479 size_t count, loff_t *off)
2480{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002481 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 unsigned long k = ULONG_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483
2484 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2485 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002486
2487 err = kstrtoul_from_user(buffer, count, 0, &k);
2488 if (err)
2489 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2491 sg_big_buff = k;
2492 return count;
2493 }
2494 return -ERANGE;
2495}
2496
2497static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2498{
2499 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2500 sg_version_date);
2501 return 0;
2502}
2503
2504static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2505{
2506 return single_open(file, sg_proc_seq_show_version, NULL);
2507}
2508
2509static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2510{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002511 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 return 0;
2513}
2514
2515static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2516{
2517 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2518}
2519
2520struct sg_proc_deviter {
2521 loff_t index;
2522 size_t max;
2523};
2524
2525static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2526{
2527 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2528
Jan Blunck729d70f2005-08-27 11:07:52 -07002529 s->private = it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 if (! it)
2531 return NULL;
Jan Blunck729d70f2005-08-27 11:07:52 -07002532
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 it->index = *pos;
2534 it->max = sg_last_dev();
2535 if (it->index >= it->max)
Jan Blunck729d70f2005-08-27 11:07:52 -07002536 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 return it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538}
2539
2540static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2541{
Jan Blunck729d70f2005-08-27 11:07:52 -07002542 struct sg_proc_deviter * it = s->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543
2544 *pos = ++it->index;
2545 return (it->index < it->max) ? it : NULL;
2546}
2547
2548static void dev_seq_stop(struct seq_file *s, void *v)
2549{
Jan Blunck729d70f2005-08-27 11:07:52 -07002550 kfree(s->private);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551}
2552
2553static int sg_proc_open_dev(struct inode *inode, struct file *file)
2554{
2555 return seq_open(file, &dev_seq_ops);
2556}
2557
2558static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2559{
2560 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2561 Sg_device *sdp;
2562 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002563 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564
Tony Battersbyc6517b792009-01-21 14:45:50 -05002565 read_lock_irqsave(&sg_index_lock, iflags);
2566 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002567 if ((NULL == sdp) || (NULL == sdp->device) ||
2568 (atomic_read(&sdp->detaching)))
2569 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2570 else {
2571 scsidp = sdp->device;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002572 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 -07002573 scsidp->host->host_no, scsidp->channel,
2574 scsidp->id, scsidp->lun, (int) scsidp->type,
2575 1,
2576 (int) scsidp->queue_depth,
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002577 (int) atomic_read(&scsidp->device_busy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 (int) scsi_device_online(scsidp));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002579 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002580 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 return 0;
2582}
2583
2584static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2585{
2586 return seq_open(file, &devstrs_seq_ops);
2587}
2588
2589static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2590{
2591 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2592 Sg_device *sdp;
2593 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002594 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595
Tony Battersbyc6517b792009-01-21 14:45:50 -05002596 read_lock_irqsave(&sg_index_lock, iflags);
2597 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002598 scsidp = sdp ? sdp->device : NULL;
2599 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2601 scsidp->vendor, scsidp->model, scsidp->rev);
2602 else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002603 seq_puts(s, "<no active device>\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002604 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 return 0;
2606}
2607
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002608/* must be called while holding sg_index_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2610{
2611 int k, m, new_interface, blen, usg;
2612 Sg_request *srp;
2613 Sg_fd *fp;
2614 const sg_io_hdr_t *hp;
2615 const char * cp;
cb59e842005-04-02 13:51:23 -06002616 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002618 k = 0;
2619 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2620 k++;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002621 read_lock(&fp->rq_list_lock); /* irqs already disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002623 "(res)sgat=%d low_dma=%d\n", k,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 jiffies_to_msecs(fp->timeout),
2625 fp->reserve.bufflen,
2626 (int) fp->reserve.k_use_sg,
2627 (int) fp->low_dma);
Jörn Engelebaf4662012-04-12 17:33:39 -04002628 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 (int) fp->cmd_q, (int) fp->force_packid,
Jörn Engelebaf4662012-04-12 17:33:39 -04002630 (int) fp->keep_orphan);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002631 for (m = 0, srp = fp->headrp;
2632 srp != NULL;
2633 ++m, srp = srp->nextrp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634 hp = &srp->header;
2635 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2636 if (srp->res_used) {
2637 if (new_interface &&
2638 (SG_FLAG_MMAP_IO & hp->flags))
2639 cp = " mmap>> ";
2640 else
2641 cp = " rb>> ";
2642 } else {
2643 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2644 cp = " dio>> ";
2645 else
2646 cp = " ";
2647 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002648 seq_puts(s, cp);
Mike Christied6b10342005-11-08 04:06:41 -06002649 blen = srp->data.bufflen;
2650 usg = srp->data.k_use_sg;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002651 seq_puts(s, srp->done ?
2652 ((1 == srp->done) ? "rcv:" : "fin:")
2653 : "act:");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 seq_printf(s, " id=%d blen=%d",
2655 srp->header.pack_id, blen);
2656 if (srp->done)
2657 seq_printf(s, " dur=%d", hp->duration);
cb59e842005-04-02 13:51:23 -06002658 else {
2659 ms = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 seq_printf(s, " t_o/elap=%d/%d",
cb59e842005-04-02 13:51:23 -06002661 (new_interface ? hp->timeout :
2662 jiffies_to_msecs(fp->timeout)),
2663 (ms > hp->duration ? ms - hp->duration : 0));
2664 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2666 (int) srp->data.cmd_opcode);
2667 }
2668 if (0 == m)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002669 seq_puts(s, " No requests active\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002670 read_unlock(&fp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 }
2672}
2673
2674static int sg_proc_open_debug(struct inode *inode, struct file *file)
2675{
2676 return seq_open(file, &debug_seq_ops);
2677}
2678
2679static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2680{
2681 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2682 Sg_device *sdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002683 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002685 if (it && (0 == it->index))
2686 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2687 (int)it->max, sg_big_buff);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002688
2689 read_lock_irqsave(&sg_index_lock, iflags);
2690 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002691 if (NULL == sdp)
2692 goto skip;
2693 read_lock(&sdp->sfd_lock);
2694 if (!list_empty(&sdp->sfds)) {
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002695 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002696 if (atomic_read(&sdp->detaching))
2697 seq_puts(s, "detaching pending close ");
2698 else if (sdp->device) {
2699 struct scsi_device *scsidp = sdp->device;
2700
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002701 seq_printf(s, "%d:%d:%d:%llu em=%d",
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002702 scsidp->host->host_no,
2703 scsidp->channel, scsidp->id,
2704 scsidp->lun,
2705 scsidp->host->hostt->emulated);
2706 }
2707 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2708 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002709 sg_proc_debug_helper(s, sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002711 read_unlock(&sdp->sfd_lock);
2712skip:
Tony Battersbyc6517b792009-01-21 14:45:50 -05002713 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714 return 0;
2715}
2716
2717#endif /* CONFIG_SCSI_PROC_FS */
2718
2719module_init(init_sg);
2720module_exit(exit_sg);