blob: dec4c70677dee667be8f0481f7455327662b07ab [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:
10 * Copyright (C) 1998 - 2005 Douglas Gilbert
11 *
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
17 * any later version.
18 *
19 */
20
Douglas Gilbertb2155d02006-08-19 00:11:34 -040021static int sg_version_num = 30534; /* 2 digits for each component */
22#define SG_VERSION_STR "3.5.34"
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24/*
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
29 *
30 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/module.h>
32
33#include <linux/fs.h>
34#include <linux/kernel.h>
35#include <linux/sched.h>
36#include <linux/string.h>
37#include <linux/mm.h>
38#include <linux/errno.h>
39#include <linux/mtio.h>
40#include <linux/ioctl.h>
41#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>
Jonathan Corbeteb09d3d2008-05-15 12:22:06 -060051#include <linux/smp_lock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53#include "scsi.h"
db9dff32005-04-03 14:53:59 -050054#include <scsi/scsi_dbg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <scsi/scsi_host.h>
56#include <scsi/scsi_driver.h>
57#include <scsi/scsi_ioctl.h>
58#include <scsi/sg.h>
59
60#include "scsi_logging.h"
61
62#ifdef CONFIG_SCSI_PROC_FS
63#include <linux/proc_fs.h>
Douglas Gilbert7ca63cb2006-10-27 17:47:49 -040064static char *sg_version_date = "20061027";
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66static int sg_proc_init(void);
67static void sg_proc_cleanup(void);
68#endif
69
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#define SG_ALLOW_DIO_DEF 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72#define SG_MAX_DEVS 32768
73
74/*
75 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
76 * Then when using 32 bit integers x * m may overflow during the calculation.
77 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
78 * calculates the same, but prevents the overflow when both m and d
79 * are "small" numbers (like HZ and USER_HZ).
80 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
81 * in 32 bits.
82 */
83#define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
84
85#define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
86
87int sg_big_buff = SG_DEF_RESERVED_SIZE;
88/* N.B. This variable is readable and writeable via
89 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
90 of this size (or less if there is not enough memory) will be reserved
91 for use by this file descriptor. [Deprecated usage: this variable is also
92 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
93 the kernel (i.e. it is not a module).] */
94static int def_reserved_size = -1; /* picks up init parameter */
95static int sg_allow_dio = SG_ALLOW_DIO_DEF;
96
Douglas Gilbert6460e752006-09-20 18:20:49 -040097static int scatter_elem_sz = SG_SCATTER_SZ;
98static int scatter_elem_sz_prev = SG_SCATTER_SZ;
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100#define SG_SECTOR_SZ 512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Tony Jonesee959b02008-02-22 00:13:36 +0100102static int sg_add(struct device *, struct class_interface *);
103static void sg_remove(struct device *, struct class_interface *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
James Bottomley7c07d612007-08-05 13:36:11 -0500105static DEFINE_IDR(sg_index_idr);
106static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 file descriptor list for device */
108
109static struct class_interface sg_interface = {
Tony Jonesee959b02008-02-22 00:13:36 +0100110 .add_dev = sg_add,
111 .remove_dev = sg_remove,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112};
113
114typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
115 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
FUJITA Tomonoriea312552007-08-06 00:31:24 +0900116 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 unsigned bufflen; /* Size of (aggregate) data buffer */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200118 struct page **pages;
119 int page_order;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
121 unsigned char cmd_opcode; /* first byte of command */
122} Sg_scatter_hold;
123
124struct sg_device; /* forward declarations */
125struct sg_fd;
126
127typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 struct sg_request *nextrp; /* NULL -> tail request (slist) */
129 struct sg_fd *parentfp; /* NULL -> not in use */
130 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
131 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
Mike Christied6b10342005-11-08 04:06:41 -0600132 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
134 char orphan; /* 1 -> drop on sight, 0 -> normal */
135 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
136 volatile char done; /* 0->before bh, 1->before read, 2->read */
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900137 struct request *rq;
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +0900138 struct bio *bio;
FUJITA Tomonoric96952e2009-02-04 11:36:27 +0900139 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140} Sg_request;
141
142typedef struct sg_fd { /* holds the state of a file descriptor */
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900143 struct list_head sfd_siblings;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 struct sg_device *parentdp; /* owning device */
145 wait_queue_head_t read_wait; /* queue read until command done */
146 rwlock_t rq_list_lock; /* protect access to list in req_arr */
147 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
148 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
149 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
150 unsigned save_scat_len; /* original length of trunc. scat. element */
151 Sg_request *headrp; /* head of request slist, NULL->empty */
152 struct fasync_struct *async_qp; /* used by asynchronous notification */
153 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
154 char low_dma; /* as in parent but possibly overridden to 1 */
155 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
156 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
157 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
158 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
159 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
160 char mmap_called; /* 0 -> mmap() never called on this fd */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500161 struct kref f_ref;
162 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163} Sg_fd;
164
165typedef struct sg_device { /* holds the state of each scsi generic device */
166 struct scsi_device *device;
167 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
168 int sg_tablesize; /* adapter's max scatter-gather table size */
James Bottomley7c07d612007-08-05 13:36:11 -0500169 u32 index; /* device index number */
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900170 struct list_head sfds;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 volatile char detached; /* 0->attached, 1->detached pending removal */
172 volatile char exclude; /* opened for exclusive access */
173 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
174 struct gendisk *disk;
175 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500176 struct kref d_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177} Sg_device;
178
Mike Christied6b10342005-11-08 04:06:41 -0600179/* tasklet or soft irq callback */
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +0900180static void sg_rq_end_io(struct request *rq, int uptodate);
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900181static int sg_start_req(Sg_request *srp, unsigned char *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182static void sg_finish_rem_req(Sg_request * srp);
183static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
185 Sg_request * srp);
Adel Gadllah0b07de82008-06-26 13:48:27 +0200186static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
187 const char __user *buf, size_t count, int blocking,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500188 int read_only, int sg_io_owned, Sg_request **o_srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
190 unsigned char *cmnd, int timeout, int blocking);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
192static void sg_remove_scat(Sg_scatter_hold * schp);
193static void sg_build_reserve(Sg_fd * sfp, int req_size);
194static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
195static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500197static void sg_remove_sfp(struct kref *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
199static Sg_request *sg_add_request(Sg_fd * sfp);
200static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
201static int sg_res_in_use(Sg_fd * sfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202static Sg_device *sg_get_dev(int dev);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500203static void sg_put_dev(Sg_device *sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205#define SZ_SG_HEADER sizeof(struct sg_header)
206#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
207#define SZ_SG_IOVEC sizeof(sg_iovec_t)
208#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
209
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900210static int sg_allow_access(struct file *filp, unsigned char *cmd)
211{
212 struct sg_fd *sfp = (struct sg_fd *)filp->private_data;
213 struct request_queue *q = sfp->parentdp->device->request_queue;
214
215 if (sfp->parentdp->device->type == TYPE_SCANNER)
216 return 0;
217
218 return blk_verify_command(&q->cmd_filter,
219 cmd, filp->f_mode & FMODE_WRITE);
220}
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222static int
223sg_open(struct inode *inode, struct file *filp)
224{
225 int dev = iminor(inode);
226 int flags = filp->f_flags;
Mike Christied6b10342005-11-08 04:06:41 -0600227 struct request_queue *q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 Sg_device *sdp;
229 Sg_fd *sfp;
230 int res;
231 int retval;
232
Jonathan Corbeteb09d3d2008-05-15 12:22:06 -0600233 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 nonseekable_open(inode, filp);
235 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
236 sdp = sg_get_dev(dev);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500237 if (IS_ERR(sdp)) {
238 retval = PTR_ERR(sdp);
239 sdp = NULL;
240 goto sg_put;
Jonathan Corbeteb09d3d2008-05-15 12:22:06 -0600241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 /* This driver's module count bumped by fops_get in <linux/fs.h> */
244 /* Prevent the device driver from vanishing while we sleep */
245 retval = scsi_device_get(sdp->device);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500246 if (retval)
247 goto sg_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 if (!((flags & O_NONBLOCK) ||
250 scsi_block_when_processing_errors(sdp->device))) {
251 retval = -ENXIO;
252 /* we are in error recovery for this device */
253 goto error_out;
254 }
255
256 if (flags & O_EXCL) {
257 if (O_RDONLY == (flags & O_ACCMODE)) {
258 retval = -EPERM; /* Can't lock it with read only access */
259 goto error_out;
260 }
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900261 if (!list_empty(&sdp->sfds) && (flags & O_NONBLOCK)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 retval = -EBUSY;
263 goto error_out;
264 }
265 res = 0;
266 __wait_event_interruptible(sdp->o_excl_wait,
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900267 ((!list_empty(&sdp->sfds) || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 if (res) {
269 retval = res; /* -ERESTARTSYS because signal hit process */
270 goto error_out;
271 }
272 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
273 if (flags & O_NONBLOCK) {
274 retval = -EBUSY;
275 goto error_out;
276 }
277 res = 0;
278 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
279 res);
280 if (res) {
281 retval = res; /* -ERESTARTSYS because signal hit process */
282 goto error_out;
283 }
284 }
285 if (sdp->detached) {
286 retval = -ENODEV;
287 goto error_out;
288 }
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900289 if (list_empty(&sdp->sfds)) { /* no existing opens on this device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 sdp->sgdebug = 0;
Mike Christied6b10342005-11-08 04:06:41 -0600291 q = sdp->device->request_queue;
292 sdp->sg_tablesize = min(q->max_hw_segments,
293 q->max_phys_segments);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 }
295 if ((sfp = sg_add_sfp(sdp, dev)))
296 filp->private_data = sfp;
297 else {
Tony Battersbyc6517b792009-01-21 14:45:50 -0500298 if (flags & O_EXCL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 sdp->exclude = 0; /* undo if error */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500300 wake_up_interruptible(&sdp->o_excl_wait);
301 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 retval = -ENOMEM;
303 goto error_out;
304 }
Tony Battersbyc6517b792009-01-21 14:45:50 -0500305 retval = 0;
306error_out:
307 if (retval)
308 scsi_device_put(sdp->device);
309sg_put:
310 if (sdp)
311 sg_put_dev(sdp);
Jonathan Corbeteb09d3d2008-05-15 12:22:06 -0600312 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 return retval;
314}
315
316/* Following function was formerly called 'sg_close' */
317static int
318sg_release(struct inode *inode, struct file *filp)
319{
320 Sg_device *sdp;
321 Sg_fd *sfp;
322
323 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
324 return -ENXIO;
325 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
Tony Battersbyc6517b792009-01-21 14:45:50 -0500326
327 sfp->closed = 1;
328
329 sdp->exclude = 0;
330 wake_up_interruptible(&sdp->o_excl_wait);
331
332 kref_put(&sfp->f_ref, sg_remove_sfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 return 0;
334}
335
336static ssize_t
337sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
338{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 Sg_device *sdp;
340 Sg_fd *sfp;
341 Sg_request *srp;
342 int req_pack_id = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 sg_io_hdr_t *hp;
cb59e842005-04-02 13:51:23 -0600344 struct sg_header *old_hdr = NULL;
345 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
348 return -ENXIO;
349 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
350 sdp->disk->disk_name, (int) count));
Mike Christied6b10342005-11-08 04:06:41 -0600351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 if (!access_ok(VERIFY_WRITE, buf, count))
353 return -EFAULT;
354 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
cb59e842005-04-02 13:51:23 -0600355 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
356 if (!old_hdr)
357 return -ENOMEM;
358 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
359 retval = -EFAULT;
360 goto free_old_hdr;
361 }
362 if (old_hdr->reply_len < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 if (count >= SZ_SG_IO_HDR) {
cb59e842005-04-02 13:51:23 -0600364 sg_io_hdr_t *new_hdr;
365 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
366 if (!new_hdr) {
367 retval = -ENOMEM;
368 goto free_old_hdr;
369 }
370 retval =__copy_from_user
371 (new_hdr, buf, SZ_SG_IO_HDR);
372 req_pack_id = new_hdr->pack_id;
373 kfree(new_hdr);
374 if (retval) {
375 retval = -EFAULT;
376 goto free_old_hdr;
377 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 }
379 } else
cb59e842005-04-02 13:51:23 -0600380 req_pack_id = old_hdr->pack_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 }
382 srp = sg_get_rq_mark(sfp, req_pack_id);
383 if (!srp) { /* now wait on packet to arrive */
cb59e842005-04-02 13:51:23 -0600384 if (sdp->detached) {
385 retval = -ENODEV;
386 goto free_old_hdr;
387 }
388 if (filp->f_flags & O_NONBLOCK) {
389 retval = -EAGAIN;
390 goto free_old_hdr;
391 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 while (1) {
cb59e842005-04-02 13:51:23 -0600393 retval = 0; /* following macro beats race condition */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 __wait_event_interruptible(sfp->read_wait,
cb59e842005-04-02 13:51:23 -0600395 (sdp->detached ||
396 (srp = sg_get_rq_mark(sfp, req_pack_id))),
397 retval);
398 if (sdp->detached) {
399 retval = -ENODEV;
400 goto free_old_hdr;
401 }
402 if (0 == retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 break;
cb59e842005-04-02 13:51:23 -0600404
405 /* -ERESTARTSYS as signal hit process */
406 goto free_old_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 }
408 }
cb59e842005-04-02 13:51:23 -0600409 if (srp->header.interface_id != '\0') {
410 retval = sg_new_read(sfp, buf, count, srp);
411 goto free_old_hdr;
412 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
414 hp = &srp->header;
cb59e842005-04-02 13:51:23 -0600415 if (old_hdr == NULL) {
416 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
417 if (! old_hdr) {
418 retval = -ENOMEM;
419 goto free_old_hdr;
420 }
421 }
422 memset(old_hdr, 0, SZ_SG_HEADER);
423 old_hdr->reply_len = (int) hp->timeout;
424 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
425 old_hdr->pack_id = hp->pack_id;
426 old_hdr->twelve_byte =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
cb59e842005-04-02 13:51:23 -0600428 old_hdr->target_status = hp->masked_status;
429 old_hdr->host_status = hp->host_status;
430 old_hdr->driver_status = hp->driver_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 if ((CHECK_CONDITION & hp->masked_status) ||
432 (DRIVER_SENSE & hp->driver_status))
cb59e842005-04-02 13:51:23 -0600433 memcpy(old_hdr->sense_buffer, srp->sense_b,
434 sizeof (old_hdr->sense_buffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 switch (hp->host_status) {
436 /* This setup of 'result' is for backward compatibility and is best
437 ignored by the user who should use target, host + driver status */
438 case DID_OK:
439 case DID_PASSTHROUGH:
440 case DID_SOFT_ERROR:
cb59e842005-04-02 13:51:23 -0600441 old_hdr->result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 break;
443 case DID_NO_CONNECT:
444 case DID_BUS_BUSY:
445 case DID_TIME_OUT:
cb59e842005-04-02 13:51:23 -0600446 old_hdr->result = EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 break;
448 case DID_BAD_TARGET:
449 case DID_ABORT:
450 case DID_PARITY:
451 case DID_RESET:
452 case DID_BAD_INTR:
cb59e842005-04-02 13:51:23 -0600453 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 break;
455 case DID_ERROR:
cb59e842005-04-02 13:51:23 -0600456 old_hdr->result = (srp->sense_b[0] == 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 hp->masked_status == GOOD) ? 0 : EIO;
458 break;
459 default:
cb59e842005-04-02 13:51:23 -0600460 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 break;
462 }
463
464 /* Now copy the result back to the user buffer. */
465 if (count >= SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600466 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
467 retval = -EFAULT;
468 goto free_old_hdr;
469 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 buf += SZ_SG_HEADER;
cb59e842005-04-02 13:51:23 -0600471 if (count > old_hdr->reply_len)
472 count = old_hdr->reply_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 if (count > SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600474 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
475 retval = -EFAULT;
476 goto free_old_hdr;
477 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 }
479 } else
cb59e842005-04-02 13:51:23 -0600480 count = (old_hdr->result == 0) ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 sg_finish_rem_req(srp);
cb59e842005-04-02 13:51:23 -0600482 retval = count;
483free_old_hdr:
Jesper Juhlc9475cb2005-11-07 01:01:26 -0800484 kfree(old_hdr);
cb59e842005-04-02 13:51:23 -0600485 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
488static ssize_t
489sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
490{
491 sg_io_hdr_t *hp = &srp->header;
492 int err = 0;
493 int len;
494
495 if (count < SZ_SG_IO_HDR) {
496 err = -EINVAL;
497 goto err_out;
498 }
499 hp->sb_len_wr = 0;
500 if ((hp->mx_sb_len > 0) && hp->sbp) {
501 if ((CHECK_CONDITION & hp->masked_status) ||
502 (DRIVER_SENSE & hp->driver_status)) {
Mike Christied6b10342005-11-08 04:06:41 -0600503 int sb_len = SCSI_SENSE_BUFFERSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
505 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
506 len = (len > sb_len) ? sb_len : len;
507 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
508 err = -EFAULT;
509 goto err_out;
510 }
511 hp->sb_len_wr = len;
512 }
513 }
514 if (hp->masked_status || hp->host_status || hp->driver_status)
515 hp->info |= SG_INFO_CHECK;
516 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
517 err = -EFAULT;
518 goto err_out;
519 }
FUJITA Tomonori0b6cb262008-09-02 22:50:07 +0900520err_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 sg_finish_rem_req(srp);
522 return (0 == err) ? count : err;
523}
524
525static ssize_t
526sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
527{
528 int mxsize, cmd_size, k;
529 int input_size, blocking;
530 unsigned char opcode;
531 Sg_device *sdp;
532 Sg_fd *sfp;
533 Sg_request *srp;
534 struct sg_header old_hdr;
535 sg_io_hdr_t *hp;
Mike Christied6b10342005-11-08 04:06:41 -0600536 unsigned char cmnd[MAX_COMMAND_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
538 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
539 return -ENXIO;
540 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
541 sdp->disk->disk_name, (int) count));
542 if (sdp->detached)
543 return -ENODEV;
544 if (!((filp->f_flags & O_NONBLOCK) ||
545 scsi_block_when_processing_errors(sdp->device)))
546 return -ENXIO;
547
548 if (!access_ok(VERIFY_READ, buf, count))
549 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
550 if (count < SZ_SG_HEADER)
551 return -EIO;
552 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
553 return -EFAULT;
554 blocking = !(filp->f_flags & O_NONBLOCK);
555 if (old_hdr.reply_len < 0)
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500556 return sg_new_write(sfp, filp, buf, count,
557 blocking, 0, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 if (count < (SZ_SG_HEADER + 6))
559 return -EIO; /* The minimum scsi command length is 6 bytes. */
560
561 if (!(srp = sg_add_request(sfp))) {
562 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
563 return -EDOM;
564 }
565 buf += SZ_SG_HEADER;
566 __get_user(opcode, buf);
567 if (sfp->next_cmd_len > 0) {
568 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
569 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
570 sfp->next_cmd_len = 0;
571 sg_remove_request(sfp, srp);
572 return -EIO;
573 }
574 cmd_size = sfp->next_cmd_len;
575 sfp->next_cmd_len = 0; /* reset so only this write() effected */
576 } else {
577 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
578 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
579 cmd_size = 12;
580 }
581 SCSI_LOG_TIMEOUT(4, printk(
582 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
583/* Determine buffer size. */
584 input_size = count - cmd_size;
585 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
586 mxsize -= SZ_SG_HEADER;
587 input_size -= SZ_SG_HEADER;
588 if (input_size < 0) {
589 sg_remove_request(sfp, srp);
590 return -EIO; /* User did not pass enough bytes for this command. */
591 }
592 hp = &srp->header;
593 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
594 hp->cmd_len = (unsigned char) cmd_size;
595 hp->iovec_count = 0;
596 hp->mx_sb_len = 0;
597 if (input_size > 0)
598 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
599 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
600 else
601 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
602 hp->dxfer_len = mxsize;
FUJITA Tomonorifad7f012008-09-02 16:20:20 +0900603 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
604 hp->dxferp = (char __user *)buf + cmd_size;
605 else
606 hp->dxferp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 hp->sbp = NULL;
608 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
609 hp->flags = input_size; /* structure abuse ... */
610 hp->pack_id = old_hdr.pack_id;
611 hp->usr_ptr = NULL;
612 if (__copy_from_user(cmnd, buf, cmd_size))
613 return -EFAULT;
614 /*
615 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
616 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
617 * is a non-zero input_size, so emit a warning.
618 */
Andi Kleeneaa3e222008-01-13 17:41:43 +0100619 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
620 static char cmd[TASK_COMM_LEN];
621 if (strcmp(current->comm, cmd) && printk_ratelimit()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 printk(KERN_WARNING
623 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
624 "guessing data in;\n" KERN_WARNING " "
625 "program %s not setting count and/or reply_len properly\n",
626 old_hdr.reply_len - (int)SZ_SG_HEADER,
627 input_size, (unsigned int) cmnd[0],
628 current->comm);
Andi Kleeneaa3e222008-01-13 17:41:43 +0100629 strcpy(cmd, current->comm);
630 }
631 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
633 return (k < 0) ? k : count;
634}
635
636static ssize_t
Adel Gadllah0b07de82008-06-26 13:48:27 +0200637sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500638 size_t count, int blocking, int read_only, int sg_io_owned,
Adel Gadllah0b07de82008-06-26 13:48:27 +0200639 Sg_request **o_srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
641 int k;
642 Sg_request *srp;
643 sg_io_hdr_t *hp;
Mike Christied6b10342005-11-08 04:06:41 -0600644 unsigned char cmnd[MAX_COMMAND_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 int timeout;
646 unsigned long ul_timeout;
647
648 if (count < SZ_SG_IO_HDR)
649 return -EINVAL;
650 if (!access_ok(VERIFY_READ, buf, count))
651 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
652
653 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
654 if (!(srp = sg_add_request(sfp))) {
655 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
656 return -EDOM;
657 }
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500658 srp->sg_io_owned = sg_io_owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 hp = &srp->header;
660 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
661 sg_remove_request(sfp, srp);
662 return -EFAULT;
663 }
664 if (hp->interface_id != 'S') {
665 sg_remove_request(sfp, srp);
666 return -ENOSYS;
667 }
668 if (hp->flags & SG_FLAG_MMAP_IO) {
669 if (hp->dxfer_len > sfp->reserve.bufflen) {
670 sg_remove_request(sfp, srp);
671 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
672 }
673 if (hp->flags & SG_FLAG_DIRECT_IO) {
674 sg_remove_request(sfp, srp);
675 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
676 }
677 if (sg_res_in_use(sfp)) {
678 sg_remove_request(sfp, srp);
679 return -EBUSY; /* reserve buffer already being used */
680 }
681 }
682 ul_timeout = msecs_to_jiffies(srp->header.timeout);
683 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
684 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
685 sg_remove_request(sfp, srp);
686 return -EMSGSIZE;
687 }
688 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
689 sg_remove_request(sfp, srp);
690 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
691 }
692 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
693 sg_remove_request(sfp, srp);
694 return -EFAULT;
695 }
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900696 if (read_only && sg_allow_access(file, cmnd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 sg_remove_request(sfp, srp);
698 return -EPERM;
699 }
700 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
701 if (k < 0)
702 return k;
703 if (o_srp)
704 *o_srp = srp;
705 return count;
706}
707
708static int
709sg_common_write(Sg_fd * sfp, Sg_request * srp,
710 unsigned char *cmnd, int timeout, int blocking)
711{
Mike Christied6b10342005-11-08 04:06:41 -0600712 int k, data_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 Sg_device *sdp = sfp->parentdp;
714 sg_io_hdr_t *hp = &srp->header;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
717 hp->status = 0;
718 hp->masked_status = 0;
719 hp->msg_status = 0;
720 hp->info = 0;
721 hp->host_status = 0;
722 hp->driver_status = 0;
723 hp->resid = 0;
724 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
725 (int) cmnd[0], (int) hp->cmd_len));
726
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900727 k = sg_start_req(srp, cmnd);
728 if (k) {
Douglas Gilbert7ca63cb2006-10-27 17:47:49 -0400729 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 sg_finish_rem_req(srp);
731 return k; /* probably out of space --> ENOMEM */
732 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 if (sdp->detached) {
734 sg_finish_rem_req(srp);
735 return -ENODEV;
736 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 switch (hp->dxfer_direction) {
739 case SG_DXFER_TO_FROM_DEV:
740 case SG_DXFER_FROM_DEV:
Mike Christied6b10342005-11-08 04:06:41 -0600741 data_dir = DMA_FROM_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 break;
743 case SG_DXFER_TO_DEV:
Mike Christied6b10342005-11-08 04:06:41 -0600744 data_dir = DMA_TO_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 break;
746 case SG_DXFER_UNKNOWN:
Mike Christied6b10342005-11-08 04:06:41 -0600747 data_dir = DMA_BIDIRECTIONAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 break;
749 default:
Mike Christied6b10342005-11-08 04:06:41 -0600750 data_dir = DMA_NONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 break;
752 }
cb59e842005-04-02 13:51:23 -0600753 hp->duration = jiffies_to_msecs(jiffies);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200754
755 srp->rq->timeout = timeout;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500756 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200757 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
758 srp->rq, 1, sg_rq_end_io);
759 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760}
761
762static int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763sg_ioctl(struct inode *inode, struct file *filp,
764 unsigned int cmd_in, unsigned long arg)
765{
766 void __user *p = (void __user *)arg;
767 int __user *ip = p;
768 int result, val, read_only;
769 Sg_device *sdp;
770 Sg_fd *sfp;
771 Sg_request *srp;
772 unsigned long iflags;
773
774 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
775 return -ENXIO;
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
778 sdp->disk->disk_name, (int) cmd_in));
779 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
780
781 switch (cmd_in) {
782 case SG_IO:
783 {
784 int blocking = 1; /* ignore O_NONBLOCK flag */
785
786 if (sdp->detached)
787 return -ENODEV;
788 if (!scsi_block_when_processing_errors(sdp->device))
789 return -ENXIO;
790 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
791 return -EFAULT;
792 result =
Adel Gadllah0b07de82008-06-26 13:48:27 +0200793 sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500794 blocking, read_only, 1, &srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 if (result < 0)
796 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 while (1) {
798 result = 0; /* following macro to beat race condition */
799 __wait_event_interruptible(sfp->read_wait,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500800 (srp->done || sdp->detached),
801 result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 if (sdp->detached)
803 return -ENODEV;
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500804 write_lock_irq(&sfp->rq_list_lock);
805 if (srp->done) {
806 srp->done = 2;
807 write_unlock_irq(&sfp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 break;
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500809 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 srp->orphan = 1;
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500811 write_unlock_irq(&sfp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return result; /* -ERESTARTSYS because signal hit process */
813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
815 return (result < 0) ? result : 0;
816 }
817 case SG_SET_TIMEOUT:
818 result = get_user(val, ip);
819 if (result)
820 return result;
821 if (val < 0)
822 return -EIO;
823 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
824 val = MULDIV (INT_MAX, USER_HZ, HZ);
825 sfp->timeout_user = val;
826 sfp->timeout = MULDIV (val, HZ, USER_HZ);
827
828 return 0;
829 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
830 /* strange ..., for backward compatibility */
831 return sfp->timeout_user;
832 case SG_SET_FORCE_LOW_DMA:
833 result = get_user(val, ip);
834 if (result)
835 return result;
836 if (val) {
837 sfp->low_dma = 1;
838 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
839 val = (int) sfp->reserve.bufflen;
840 sg_remove_scat(&sfp->reserve);
841 sg_build_reserve(sfp, val);
842 }
843 } else {
844 if (sdp->detached)
845 return -ENODEV;
846 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
847 }
848 return 0;
849 case SG_GET_LOW_DMA:
850 return put_user((int) sfp->low_dma, ip);
851 case SG_GET_SCSI_ID:
852 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
853 return -EFAULT;
854 else {
855 sg_scsi_id_t __user *sg_idp = p;
856
857 if (sdp->detached)
858 return -ENODEV;
859 __put_user((int) sdp->device->host->host_no,
860 &sg_idp->host_no);
861 __put_user((int) sdp->device->channel,
862 &sg_idp->channel);
863 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
864 __put_user((int) sdp->device->lun, &sg_idp->lun);
865 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
866 __put_user((short) sdp->device->host->cmd_per_lun,
867 &sg_idp->h_cmd_per_lun);
868 __put_user((short) sdp->device->queue_depth,
869 &sg_idp->d_queue_depth);
870 __put_user(0, &sg_idp->unused[0]);
871 __put_user(0, &sg_idp->unused[1]);
872 return 0;
873 }
874 case SG_SET_FORCE_PACK_ID:
875 result = get_user(val, ip);
876 if (result)
877 return result;
878 sfp->force_packid = val ? 1 : 0;
879 return 0;
880 case SG_GET_PACK_ID:
881 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
882 return -EFAULT;
883 read_lock_irqsave(&sfp->rq_list_lock, iflags);
884 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
885 if ((1 == srp->done) && (!srp->sg_io_owned)) {
886 read_unlock_irqrestore(&sfp->rq_list_lock,
887 iflags);
888 __put_user(srp->header.pack_id, ip);
889 return 0;
890 }
891 }
892 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
893 __put_user(-1, ip);
894 return 0;
895 case SG_GET_NUM_WAITING:
896 read_lock_irqsave(&sfp->rq_list_lock, iflags);
897 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
898 if ((1 == srp->done) && (!srp->sg_io_owned))
899 ++val;
900 }
901 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
902 return put_user(val, ip);
903 case SG_GET_SG_TABLESIZE:
904 return put_user(sdp->sg_tablesize, ip);
905 case SG_SET_RESERVED_SIZE:
906 result = get_user(val, ip);
907 if (result)
908 return result;
909 if (val < 0)
910 return -EINVAL;
Alan Stern44ec9542007-02-20 11:01:57 -0500911 val = min_t(int, val,
912 sdp->device->request_queue->max_sectors * 512);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 if (val != sfp->reserve.bufflen) {
914 if (sg_res_in_use(sfp) || sfp->mmap_called)
915 return -EBUSY;
916 sg_remove_scat(&sfp->reserve);
917 sg_build_reserve(sfp, val);
918 }
919 return 0;
920 case SG_GET_RESERVED_SIZE:
Alan Stern44ec9542007-02-20 11:01:57 -0500921 val = min_t(int, sfp->reserve.bufflen,
922 sdp->device->request_queue->max_sectors * 512);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 return put_user(val, ip);
924 case SG_SET_COMMAND_Q:
925 result = get_user(val, ip);
926 if (result)
927 return result;
928 sfp->cmd_q = val ? 1 : 0;
929 return 0;
930 case SG_GET_COMMAND_Q:
931 return put_user((int) sfp->cmd_q, ip);
932 case SG_SET_KEEP_ORPHAN:
933 result = get_user(val, ip);
934 if (result)
935 return result;
936 sfp->keep_orphan = val;
937 return 0;
938 case SG_GET_KEEP_ORPHAN:
939 return put_user((int) sfp->keep_orphan, ip);
940 case SG_NEXT_CMD_LEN:
941 result = get_user(val, ip);
942 if (result)
943 return result;
944 sfp->next_cmd_len = (val > 0) ? val : 0;
945 return 0;
946 case SG_GET_VERSION_NUM:
947 return put_user(sg_version_num, ip);
948 case SG_GET_ACCESS_COUNT:
949 /* faked - we don't have a real access count anymore */
950 val = (sdp->device ? 1 : 0);
951 return put_user(val, ip);
952 case SG_GET_REQUEST_TABLE:
953 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
954 return -EFAULT;
955 else {
cb59e842005-04-02 13:51:23 -0600956 sg_req_info_t *rinfo;
957 unsigned int ms;
958
959 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
960 GFP_KERNEL);
961 if (!rinfo)
962 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 read_lock_irqsave(&sfp->rq_list_lock, iflags);
964 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
965 ++val, srp = srp ? srp->nextrp : srp) {
966 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
967 if (srp) {
968 rinfo[val].req_state = srp->done + 1;
969 rinfo[val].problem =
970 srp->header.masked_status &
971 srp->header.host_status &
972 srp->header.driver_status;
cb59e842005-04-02 13:51:23 -0600973 if (srp->done)
974 rinfo[val].duration =
975 srp->header.duration;
976 else {
977 ms = jiffies_to_msecs(jiffies);
978 rinfo[val].duration =
979 (ms > srp->header.duration) ?
980 (ms - srp->header.duration) : 0;
981 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 rinfo[val].orphan = srp->orphan;
cb59e842005-04-02 13:51:23 -0600983 rinfo[val].sg_io_owned =
984 srp->sg_io_owned;
985 rinfo[val].pack_id =
986 srp->header.pack_id;
987 rinfo[val].usr_ptr =
988 srp->header.usr_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 }
990 }
991 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
cb59e842005-04-02 13:51:23 -0600992 result = __copy_to_user(p, rinfo,
993 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
994 result = result ? -EFAULT : 0;
995 kfree(rinfo);
996 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 }
998 case SG_EMULATED_HOST:
999 if (sdp->detached)
1000 return -ENODEV;
1001 return put_user(sdp->device->host->hostt->emulated, ip);
1002 case SG_SCSI_RESET:
1003 if (sdp->detached)
1004 return -ENODEV;
1005 if (filp->f_flags & O_NONBLOCK) {
James Bottomley939647e2005-09-18 15:05:20 -05001006 if (scsi_host_in_recovery(sdp->device->host))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 return -EBUSY;
1008 } else if (!scsi_block_when_processing_errors(sdp->device))
1009 return -EBUSY;
1010 result = get_user(val, ip);
1011 if (result)
1012 return result;
1013 if (SG_SCSI_RESET_NOTHING == val)
1014 return 0;
1015 switch (val) {
1016 case SG_SCSI_RESET_DEVICE:
1017 val = SCSI_TRY_RESET_DEVICE;
1018 break;
Brian King39120e12008-07-01 13:03:19 -05001019 case SG_SCSI_RESET_TARGET:
1020 val = SCSI_TRY_RESET_TARGET;
1021 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 case SG_SCSI_RESET_BUS:
1023 val = SCSI_TRY_RESET_BUS;
1024 break;
1025 case SG_SCSI_RESET_HOST:
1026 val = SCSI_TRY_RESET_HOST;
1027 break;
1028 default:
1029 return -EINVAL;
1030 }
1031 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1032 return -EACCES;
1033 return (scsi_reset_provider(sdp->device, val) ==
1034 SUCCESS) ? 0 : -EIO;
1035 case SCSI_IOCTL_SEND_COMMAND:
1036 if (sdp->detached)
1037 return -ENODEV;
1038 if (read_only) {
1039 unsigned char opcode = WRITE_6;
1040 Scsi_Ioctl_Command __user *siocp = p;
1041
1042 if (copy_from_user(&opcode, siocp->data, 1))
1043 return -EFAULT;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +09001044 if (sg_allow_access(filp, &opcode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 return -EPERM;
1046 }
Al Viroe915e872008-09-02 17:16:41 -04001047 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 case SG_SET_DEBUG:
1049 result = get_user(val, ip);
1050 if (result)
1051 return result;
1052 sdp->sgdebug = (char) val;
1053 return 0;
1054 case SCSI_IOCTL_GET_IDLUN:
1055 case SCSI_IOCTL_GET_BUS_NUMBER:
1056 case SCSI_IOCTL_PROBE_HOST:
1057 case SG_GET_TRANSFORM:
1058 if (sdp->detached)
1059 return -ENODEV;
1060 return scsi_ioctl(sdp->device, cmd_in, p);
Alan Stern44ec9542007-02-20 11:01:57 -05001061 case BLKSECTGET:
1062 return put_user(sdp->device->request_queue->max_sectors * 512,
1063 ip);
Christof Schmitt6da127a2008-01-11 10:09:43 +01001064 case BLKTRACESETUP:
1065 return blk_trace_setup(sdp->device->request_queue,
1066 sdp->disk->disk_name,
Martin Peschke76e3a192009-01-30 15:46:23 +01001067 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
Christof Schmitt6da127a2008-01-11 10:09:43 +01001068 (char *)arg);
1069 case BLKTRACESTART:
1070 return blk_trace_startstop(sdp->device->request_queue, 1);
1071 case BLKTRACESTOP:
1072 return blk_trace_startstop(sdp->device->request_queue, 0);
1073 case BLKTRACETEARDOWN:
1074 return blk_trace_remove(sdp->device->request_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 default:
1076 if (read_only)
1077 return -EPERM; /* don't know so take safe approach */
1078 return scsi_ioctl(sdp->device, cmd_in, p);
1079 }
1080}
1081
1082#ifdef CONFIG_COMPAT
1083static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1084{
1085 Sg_device *sdp;
1086 Sg_fd *sfp;
1087 struct scsi_device *sdev;
1088
1089 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1090 return -ENXIO;
1091
1092 sdev = sdp->device;
1093 if (sdev->host->hostt->compat_ioctl) {
1094 int ret;
1095
1096 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1097
1098 return ret;
1099 }
1100
1101 return -ENOIOCTLCMD;
1102}
1103#endif
1104
1105static unsigned int
1106sg_poll(struct file *filp, poll_table * wait)
1107{
1108 unsigned int res = 0;
1109 Sg_device *sdp;
1110 Sg_fd *sfp;
1111 Sg_request *srp;
1112 int count = 0;
1113 unsigned long iflags;
1114
1115 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1116 || sfp->closed)
1117 return POLLERR;
1118 poll_wait(filp, &sfp->read_wait, wait);
1119 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1120 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1121 /* if any read waiting, flag it */
1122 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1123 res = POLLIN | POLLRDNORM;
1124 ++count;
1125 }
1126 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1127
1128 if (sdp->detached)
1129 res |= POLLHUP;
1130 else if (!sfp->cmd_q) {
1131 if (0 == count)
1132 res |= POLLOUT | POLLWRNORM;
1133 } else if (count < SG_MAX_QUEUE)
1134 res |= POLLOUT | POLLWRNORM;
1135 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1136 sdp->disk->disk_name, (int) res));
1137 return res;
1138}
1139
1140static int
1141sg_fasync(int fd, struct file *filp, int mode)
1142{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 Sg_device *sdp;
1144 Sg_fd *sfp;
1145
1146 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1147 return -ENXIO;
1148 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1149 sdp->disk->disk_name, mode));
1150
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001151 return fasync_helper(fd, filp, mode, &sfp->async_qp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152}
1153
Nick Piggina13ff0b2008-02-07 18:46:06 -08001154static int
1155sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156{
1157 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001158 unsigned long offset, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001160 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161
1162 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
Nick Piggina13ff0b2008-02-07 18:46:06 -08001163 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 rsv_schp = &sfp->reserve;
Nick Piggina13ff0b2008-02-07 18:46:06 -08001165 offset = vmf->pgoff << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 if (offset >= rsv_schp->bufflen)
Nick Piggina13ff0b2008-02-07 18:46:06 -08001167 return VM_FAULT_SIGBUS;
1168 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 offset, rsv_schp->k_use_sg));
Mike Christied6b10342005-11-08 04:06:41 -06001170 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001171 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1172 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001173 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001174 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001175 if (offset < len) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001176 struct page *page = nth_page(rsv_schp->pages[k],
1177 offset >> PAGE_SHIFT);
Mike Christied6b10342005-11-08 04:06:41 -06001178 get_page(page); /* increment page count */
Nick Piggina13ff0b2008-02-07 18:46:06 -08001179 vmf->page = page;
1180 return 0; /* success */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 }
Mike Christied6b10342005-11-08 04:06:41 -06001182 sa += len;
1183 offset -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 }
Mike Christied6b10342005-11-08 04:06:41 -06001185
Nick Piggina13ff0b2008-02-07 18:46:06 -08001186 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187}
1188
1189static struct vm_operations_struct sg_mmap_vm_ops = {
Nick Piggina13ff0b2008-02-07 18:46:06 -08001190 .fault = sg_vma_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191};
1192
1193static int
1194sg_mmap(struct file *filp, struct vm_area_struct *vma)
1195{
1196 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001197 unsigned long req_sz, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001199 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
1201 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1202 return -ENXIO;
cb59e842005-04-02 13:51:23 -06001203 req_sz = vma->vm_end - vma->vm_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1205 (void *) vma->vm_start, (int) req_sz));
1206 if (vma->vm_pgoff)
1207 return -EINVAL; /* want no offset */
1208 rsv_schp = &sfp->reserve;
1209 if (req_sz > rsv_schp->bufflen)
1210 return -ENOMEM; /* cannot map more than reserved buffer */
1211
Mike Christied6b10342005-11-08 04:06:41 -06001212 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001213 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1214 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001215 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001216 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001217 sa += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 }
Mike Christied6b10342005-11-08 04:06:41 -06001219
Nick Pigginf9aed0e2006-03-22 00:08:30 -08001220 sfp->mmap_called = 1;
Douglas Gilbert1c8e71d2005-09-09 17:18:57 +10001221 vma->vm_flags |= VM_RESERVED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 vma->vm_private_data = sfp;
1223 vma->vm_ops = &sg_mmap_vm_ops;
1224 return 0;
1225}
1226
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001227static void sg_rq_end_io_usercontext(struct work_struct *work)
1228{
1229 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1230 struct sg_fd *sfp = srp->parentfp;
1231
1232 sg_finish_rem_req(srp);
1233 kref_put(&sfp->f_ref, sg_remove_sfp);
1234}
1235
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001236/*
1237 * This function is a "bottom half" handler that is called by the mid
1238 * level when a command is completed (or has failed).
1239 */
1240static void sg_rq_end_io(struct request *rq, int uptodate)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241{
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001242 struct sg_request *srp = rq->end_io_data;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001243 Sg_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 unsigned long iflags;
cb59e842005-04-02 13:51:23 -06001246 unsigned int ms;
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001247 char *sense;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001248 int result, resid, done = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
Tony Battersbyc6517b792009-01-21 14:45:50 -05001250 if (WARN_ON(srp->done != 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 sfp = srp->parentfp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001254 if (WARN_ON(sfp == NULL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001256
1257 sdp = sfp->parentdp;
1258 if (unlikely(sdp->detached))
1259 printk(KERN_INFO "sg_rq_end_io: device detached\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001261 sense = rq->sense;
1262 result = rq->errors;
Tejun Heoc3a4d782009-05-07 22:24:37 +09001263 resid = rq->resid_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
1265 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
Mike Christied6b10342005-11-08 04:06:41 -06001266 sdp->disk->disk_name, srp->header.pack_id, result));
1267 srp->header.resid = resid;
cb59e842005-04-02 13:51:23 -06001268 ms = jiffies_to_msecs(jiffies);
1269 srp->header.duration = (ms > srp->header.duration) ?
1270 (ms - srp->header.duration) : 0;
Mike Christied6b10342005-11-08 04:06:41 -06001271 if (0 != result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 struct scsi_sense_hdr sshdr;
1273
Mike Christied6b10342005-11-08 04:06:41 -06001274 srp->header.status = 0xff & result;
1275 srp->header.masked_status = status_byte(result);
1276 srp->header.msg_status = msg_byte(result);
1277 srp->header.host_status = host_byte(result);
1278 srp->header.driver_status = driver_byte(result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 if ((sdp->sgdebug > 0) &&
1280 ((CHECK_CONDITION == srp->header.masked_status) ||
1281 (COMMAND_TERMINATED == srp->header.masked_status)))
Mike Christied6b10342005-11-08 04:06:41 -06001282 __scsi_print_sense("sg_cmd_done", sense,
1283 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285 /* Following if statement is a patch supplied by Eric Youngdale */
Mike Christied6b10342005-11-08 04:06:41 -06001286 if (driver_byte(result) != 0
1287 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 && !scsi_sense_is_deferred(&sshdr)
1289 && sshdr.sense_key == UNIT_ATTENTION
1290 && sdp->device->removable) {
1291 /* Detected possible disc change. Set the bit - this */
1292 /* may be used if there are filesystems using this device */
1293 sdp->device->changed = 1;
1294 }
1295 }
1296 /* Rely on write phase to clean out srp status values, so no "else" */
1297
Tony Battersbyc6517b792009-01-21 14:45:50 -05001298 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1299 if (unlikely(srp->orphan)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 if (sfp->keep_orphan)
1301 srp->sg_io_owned = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001302 else
1303 done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001305 srp->done = done;
1306 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1307
1308 if (likely(done)) {
1309 /* Now wake up any sg_read() that is waiting for this
1310 * packet.
1311 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 wake_up_interruptible(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001313 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001314 kref_put(&sfp->f_ref, sg_remove_sfp);
FUJITA Tomonori015640e2009-04-03 19:28:06 +09001315 } else {
1316 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1317 schedule_work(&srp->ew.work);
1318 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319}
1320
1321static struct file_operations sg_fops = {
1322 .owner = THIS_MODULE,
1323 .read = sg_read,
1324 .write = sg_write,
1325 .poll = sg_poll,
1326 .ioctl = sg_ioctl,
1327#ifdef CONFIG_COMPAT
1328 .compat_ioctl = sg_compat_ioctl,
1329#endif
1330 .open = sg_open,
1331 .mmap = sg_mmap,
1332 .release = sg_release,
1333 .fasync = sg_fasync,
1334};
1335
gregkh@suse.ded2538782005-03-23 09:55:22 -08001336static struct class *sg_sysfs_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
1338static int sg_sysfs_valid = 0;
1339
James Bottomley7c07d612007-08-05 13:36:11 -05001340static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341{
Mike Christied6b10342005-11-08 04:06:41 -06001342 struct request_queue *q = scsidp->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 Sg_device *sdp;
1344 unsigned long iflags;
James Bottomley7c07d612007-08-05 13:36:11 -05001345 int error;
1346 u32 k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347
Jes Sorensen24669f752006-01-16 10:31:18 -05001348 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 if (!sdp) {
1350 printk(KERN_WARNING "kmalloc Sg_device failure\n");
James Bottomley7c07d612007-08-05 13:36:11 -05001351 return ERR_PTR(-ENOMEM);
1352 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001353
James Bottomley7c07d612007-08-05 13:36:11 -05001354 if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
1355 printk(KERN_WARNING "idr expansion Sg_device failure\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05001356 error = -ENOMEM;
James Bottomley7c07d612007-08-05 13:36:11 -05001357 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 }
1359
James Bottomley7c07d612007-08-05 13:36:11 -05001360 write_lock_irqsave(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
Tony Battersbyc6517b792009-01-21 14:45:50 -05001362 error = idr_get_new(&sg_index_idr, sdp, &k);
James Bottomley7c07d612007-08-05 13:36:11 -05001363 if (error) {
Tony Battersbyc6517b792009-01-21 14:45:50 -05001364 write_unlock_irqrestore(&sg_index_lock, iflags);
James Bottomley7c07d612007-08-05 13:36:11 -05001365 printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
1366 error);
1367 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 }
1369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 if (unlikely(k >= SG_MAX_DEVS))
1371 goto overflow;
1372
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1374 sprintf(disk->disk_name, "sg%d", k);
1375 disk->first_minor = k;
1376 sdp->disk = disk;
1377 sdp->device = scsidp;
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001378 INIT_LIST_HEAD(&sdp->sfds);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 init_waitqueue_head(&sdp->o_excl_wait);
Mike Christied6b10342005-11-08 04:06:41 -06001380 sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
James Bottomley7c07d612007-08-05 13:36:11 -05001381 sdp->index = k;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001382 kref_init(&sdp->d_ref);
1383
1384 write_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
James Bottomley7c07d612007-08-05 13:36:11 -05001386 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 out:
James Bottomley7c07d612007-08-05 13:36:11 -05001388 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 kfree(sdp);
James Bottomley7c07d612007-08-05 13:36:11 -05001390 return ERR_PTR(error);
1391 }
1392 return sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
1394 overflow:
Tony Battersbyc6517b792009-01-21 14:45:50 -05001395 idr_remove(&sg_index_idr, k);
1396 write_unlock_irqrestore(&sg_index_lock, iflags);
James Bottomley9ccfc752005-10-02 11:45:08 -05001397 sdev_printk(KERN_WARNING, scsidp,
1398 "Unable to attach sg device type=%d, minor "
1399 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 error = -ENODEV;
1401 goto out;
1402}
1403
1404static int
Tony Jonesee959b02008-02-22 00:13:36 +01001405sg_add(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406{
Tony Jonesee959b02008-02-22 00:13:36 +01001407 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 struct gendisk *disk;
1409 Sg_device *sdp = NULL;
1410 struct cdev * cdev = NULL;
James Bottomley7c07d612007-08-05 13:36:11 -05001411 int error;
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001412 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
1414 disk = alloc_disk(1);
1415 if (!disk) {
1416 printk(KERN_WARNING "alloc_disk failed\n");
1417 return -ENOMEM;
1418 }
1419 disk->major = SCSI_GENERIC_MAJOR;
1420
1421 error = -ENOMEM;
1422 cdev = cdev_alloc();
1423 if (!cdev) {
1424 printk(KERN_WARNING "cdev_alloc failed\n");
1425 goto out;
1426 }
1427 cdev->owner = THIS_MODULE;
1428 cdev->ops = &sg_fops;
1429
James Bottomley7c07d612007-08-05 13:36:11 -05001430 sdp = sg_alloc(disk, scsidp);
1431 if (IS_ERR(sdp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 printk(KERN_WARNING "sg_alloc failed\n");
James Bottomley7c07d612007-08-05 13:36:11 -05001433 error = PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 goto out;
1435 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
James Bottomley7c07d612007-08-05 13:36:11 -05001437 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
Greg KH5e3c34c2006-01-18 16:17:46 -08001438 if (error)
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001439 goto cdev_add_err;
Greg KH5e3c34c2006-01-18 16:17:46 -08001440
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 sdp->cdev = cdev;
1442 if (sg_sysfs_valid) {
Tony Jonesee959b02008-02-22 00:13:36 +01001443 struct device *sg_class_member;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
Greg Kroah-Hartmand73a1a672008-07-21 20:03:34 -07001445 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1446 MKDEV(SCSI_GENERIC_MAJOR,
1447 sdp->index),
1448 sdp, "%s", disk->disk_name);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001449 if (IS_ERR(sg_class_member)) {
1450 printk(KERN_ERR "sg_add: "
Tony Jonesee959b02008-02-22 00:13:36 +01001451 "device_create failed\n");
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001452 error = PTR_ERR(sg_class_member);
1453 goto cdev_add_err;
1454 }
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001455 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 &sg_class_member->kobj, "generic");
1457 if (error)
1458 printk(KERN_ERR "sg_add: unable to make symlink "
James Bottomley7c07d612007-08-05 13:36:11 -05001459 "'generic' back to sg%d\n", sdp->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 } else
James Bottomley7c07d612007-08-05 13:36:11 -05001461 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
James Bottomley9ccfc752005-10-02 11:45:08 -05001463 sdev_printk(KERN_NOTICE, scsidp,
James Bottomley7c07d612007-08-05 13:36:11 -05001464 "Attached scsi generic sg%d type %d\n", sdp->index,
1465 scsidp->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Tony Jonesee959b02008-02-22 00:13:36 +01001467 dev_set_drvdata(cl_dev, sdp);
FUJITA Tomonoria24484f2008-01-15 13:17:47 +09001468
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 return 0;
1470
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001471cdev_add_err:
James Bottomley7c07d612007-08-05 13:36:11 -05001472 write_lock_irqsave(&sg_index_lock, iflags);
1473 idr_remove(&sg_index_idr, sdp->index);
1474 write_unlock_irqrestore(&sg_index_lock, iflags);
1475 kfree(sdp);
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477out:
1478 put_disk(disk);
1479 if (cdev)
1480 cdev_del(cdev);
1481 return error;
1482}
1483
Tony Battersbyc6517b792009-01-21 14:45:50 -05001484static void sg_device_destroy(struct kref *kref)
1485{
1486 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1487 unsigned long flags;
1488
1489 /* CAUTION! Note that the device can still be found via idr_find()
1490 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1491 * any other cleanup.
1492 */
1493
1494 write_lock_irqsave(&sg_index_lock, flags);
1495 idr_remove(&sg_index_idr, sdp->index);
1496 write_unlock_irqrestore(&sg_index_lock, flags);
1497
1498 SCSI_LOG_TIMEOUT(3,
1499 printk("sg_device_destroy: %s\n",
1500 sdp->disk->disk_name));
1501
1502 put_disk(sdp->disk);
1503 kfree(sdp);
1504}
1505
1506static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
Tony Jonesee959b02008-02-22 00:13:36 +01001508 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1509 Sg_device *sdp = dev_get_drvdata(cl_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 unsigned long iflags;
1511 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
Tony Battersbyc6517b792009-01-21 14:45:50 -05001513 if (!sdp || sdp->detached)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Tony Battersbyc6517b792009-01-21 14:45:50 -05001516 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1517
1518 /* Need a write lock to set sdp->detached. */
James Bottomley7c07d612007-08-05 13:36:11 -05001519 write_lock_irqsave(&sg_index_lock, iflags);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001520 sdp->detached = 1;
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001521 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
Tony Battersbyc6517b792009-01-21 14:45:50 -05001522 wake_up_interruptible(&sfp->read_wait);
1523 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 }
James Bottomley7c07d612007-08-05 13:36:11 -05001525 write_unlock_irqrestore(&sg_index_lock, iflags);
1526
1527 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
Tony Jonesee959b02008-02-22 00:13:36 +01001528 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
James Bottomley7c07d612007-08-05 13:36:11 -05001529 cdev_del(sdp->cdev);
1530 sdp->cdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Tony Battersbyc6517b792009-01-21 14:45:50 -05001532 sg_put_dev(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533}
1534
Douglas Gilbert6460e752006-09-20 18:20:49 -04001535module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1536module_param_named(def_reserved_size, def_reserved_size, int,
1537 S_IRUGO | S_IWUSR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1539
1540MODULE_AUTHOR("Douglas Gilbert");
1541MODULE_DESCRIPTION("SCSI generic (sg) driver");
1542MODULE_LICENSE("GPL");
1543MODULE_VERSION(SG_VERSION_STR);
Rene Hermanf018fa52006-03-08 00:14:20 -08001544MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Douglas Gilbert6460e752006-09-20 18:20:49 -04001546MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1547 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1549MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1550
1551static int __init
1552init_sg(void)
1553{
1554 int rc;
1555
Douglas Gilbert6460e752006-09-20 18:20:49 -04001556 if (scatter_elem_sz < PAGE_SIZE) {
1557 scatter_elem_sz = PAGE_SIZE;
1558 scatter_elem_sz_prev = scatter_elem_sz;
1559 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 if (def_reserved_size >= 0)
1561 sg_big_buff = def_reserved_size;
Douglas Gilbert6460e752006-09-20 18:20:49 -04001562 else
1563 def_reserved_size = sg_big_buff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
1565 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1566 SG_MAX_DEVS, "sg");
1567 if (rc)
1568 return rc;
gregkh@suse.ded2538782005-03-23 09:55:22 -08001569 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 if ( IS_ERR(sg_sysfs_class) ) {
1571 rc = PTR_ERR(sg_sysfs_class);
1572 goto err_out;
1573 }
1574 sg_sysfs_valid = 1;
1575 rc = scsi_register_interface(&sg_interface);
1576 if (0 == rc) {
1577#ifdef CONFIG_SCSI_PROC_FS
1578 sg_proc_init();
1579#endif /* CONFIG_SCSI_PROC_FS */
1580 return 0;
1581 }
gregkh@suse.ded2538782005-03-23 09:55:22 -08001582 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583err_out:
1584 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1585 return rc;
1586}
1587
1588static void __exit
1589exit_sg(void)
1590{
1591#ifdef CONFIG_SCSI_PROC_FS
1592 sg_proc_cleanup();
1593#endif /* CONFIG_SCSI_PROC_FS */
1594 scsi_unregister_interface(&sg_interface);
gregkh@suse.ded2538782005-03-23 09:55:22 -08001595 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 sg_sysfs_valid = 0;
1597 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1598 SG_MAX_DEVS);
James Bottomley7c07d612007-08-05 13:36:11 -05001599 idr_destroy(&sg_index_idr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600}
1601
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001602static int sg_start_req(Sg_request *srp, unsigned char *cmd)
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001603{
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001604 int res;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001605 struct request *rq;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001606 Sg_fd *sfp = srp->parentfp;
1607 sg_io_hdr_t *hp = &srp->header;
1608 int dxfer_len = (int) hp->dxfer_len;
1609 int dxfer_dir = hp->dxfer_direction;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001610 unsigned int iov_count = hp->iovec_count;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001611 Sg_scatter_hold *req_schp = &srp->data;
1612 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1613 struct request_queue *q = sfp->parentdp->device->request_queue;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001614 struct rq_map_data *md, map_data;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001615 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1616
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001617 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1618 dxfer_len));
1619
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001620 rq = blk_get_request(q, rw, GFP_ATOMIC);
1621 if (!rq)
1622 return -ENOMEM;
1623
1624 memcpy(rq->cmd, cmd, hp->cmd_len);
1625
1626 rq->cmd_len = hp->cmd_len;
1627 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1628
1629 srp->rq = rq;
1630 rq->end_io_data = srp;
1631 rq->sense = srp->sense_b;
1632 rq->retries = SG_DEFAULT_RETRIES;
1633
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001635 return 0;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001636
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001637 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1638 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1639 !sfp->parentdp->device->host->unchecked_isa_dma &&
FUJITA Tomonori01cfcdd2008-08-28 15:05:59 +09001640 blk_rq_aligned(q, hp->dxferp, dxfer_len))
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001641 md = NULL;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001642 else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001643 md = &map_data;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001644
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001645 if (md) {
1646 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1647 sg_link_reserve(sfp, srp, dxfer_len);
1648 else {
1649 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1650 if (res)
1651 return res;
1652 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001653
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001654 md->pages = req_schp->pages;
1655 md->page_order = req_schp->page_order;
1656 md->nr_entries = req_schp->k_use_sg;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001657 md->offset = 0;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +09001658 md->null_mapped = hp->dxferp ? 0 : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001660
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001661 if (iov_count) {
1662 int len, size = sizeof(struct sg_iovec) * iov_count;
1663 struct iovec *iov;
1664
1665 iov = kmalloc(size, GFP_ATOMIC);
1666 if (!iov)
1667 return -ENOMEM;
1668
1669 if (copy_from_user(iov, hp->dxferp, size)) {
1670 kfree(iov);
1671 return -EFAULT;
1672 }
1673
1674 len = iov_length(iov, iov_count);
1675 if (hp->dxfer_len < len) {
1676 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1677 len = hp->dxfer_len;
1678 }
1679
1680 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1681 iov_count,
1682 len, GFP_ATOMIC);
1683 kfree(iov);
1684 } else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001685 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1686 hp->dxfer_len, GFP_ATOMIC);
1687
1688 if (!res) {
1689 srp->bio = rq->bio;
1690
1691 if (!md) {
1692 req_schp->dio_in_use = 1;
1693 hp->info |= SG_INFO_DIRECT_IO;
1694 }
1695 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001696 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697}
1698
1699static void
1700sg_finish_rem_req(Sg_request * srp)
1701{
1702 Sg_fd *sfp = srp->parentfp;
1703 Sg_scatter_hold *req_schp = &srp->data;
1704
1705 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1706 if (srp->res_used)
1707 sg_unlink_reserve(sfp, srp);
1708 else
1709 sg_remove_scat(req_schp);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001710
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001711 if (srp->rq) {
1712 if (srp->bio)
1713 blk_rq_unmap_user(srp->bio);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001714
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001715 blk_put_request(srp->rq);
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001716 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001717
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 sg_remove_request(sfp, srp);
1719}
1720
1721static int
1722sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1723{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001724 int sg_bufflen = tablesize * sizeof(struct page *);
Al Viro2d20eaf2006-02-01 06:31:40 -05001725 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001727 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1728 if (!schp->pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 schp->sglist_len = sg_bufflen;
Mike Christied6b10342005-11-08 04:06:41 -06001731 return tablesize; /* number of scat_gath elements allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732}
1733
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734static int
1735sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1736{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001737 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
Mike Christied6b10342005-11-08 04:06:41 -06001738 int sg_tablesize = sfp->parentdp->sg_tablesize;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001739 int blk_size = buff_size, order;
1740 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
Eric Sesterhennfb119932007-05-23 14:41:36 -07001742 if (blk_size < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 return -EFAULT;
1744 if (0 == blk_size)
1745 ++blk_size; /* don't know why */
FUJITA Tomonorib2ed6c62009-02-12 02:42:57 +09001746 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1747 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1749 buff_size, blk_size));
Mike Christied6b10342005-11-08 04:06:41 -06001750
1751 /* N.B. ret_sz carried into this block ... */
1752 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1753 if (mx_sc_elems < 0)
1754 return mx_sc_elems; /* most likely -ENOMEM */
1755
Douglas Gilbert6460e752006-09-20 18:20:49 -04001756 num = scatter_elem_sz;
1757 if (unlikely(num != scatter_elem_sz_prev)) {
1758 if (num < PAGE_SIZE) {
1759 scatter_elem_sz = PAGE_SIZE;
1760 scatter_elem_sz_prev = PAGE_SIZE;
1761 } else
1762 scatter_elem_sz_prev = num;
1763 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001764
1765 if (sfp->low_dma)
1766 gfp_mask |= GFP_DMA;
1767
1768 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1769 gfp_mask |= __GFP_ZERO;
1770
1771 order = get_order(num);
1772retry:
1773 ret_sz = 1 << (PAGE_SHIFT + order);
1774
1775 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1776 k++, rem_sz -= ret_sz) {
1777
Douglas Gilbert6460e752006-09-20 18:20:49 -04001778 num = (rem_sz > scatter_elem_sz_prev) ?
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001779 scatter_elem_sz_prev : rem_sz;
1780
1781 schp->pages[k] = alloc_pages(gfp_mask, order);
1782 if (!schp->pages[k])
1783 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Douglas Gilbert6460e752006-09-20 18:20:49 -04001785 if (num == scatter_elem_sz_prev) {
1786 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1787 scatter_elem_sz = ret_sz;
1788 scatter_elem_sz_prev = ret_sz;
1789 }
1790 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
Douglas Gilbert7ca63cb2006-10-27 17:47:49 -04001792 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1793 "ret_sz=%d\n", k, num, ret_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001794 } /* end of for loop */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001796 schp->page_order = order;
Mike Christied6b10342005-11-08 04:06:41 -06001797 schp->k_use_sg = k;
Douglas Gilbert7ca63cb2006-10-27 17:47:49 -04001798 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1799 "rem_sz=%d\n", k, rem_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001800
1801 schp->bufflen = blk_size;
1802 if (rem_sz > 0) /* must have failed */
1803 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 return 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001805out:
1806 for (i = 0; i < k; i++)
1807 __free_pages(schp->pages[k], order);
1808
1809 if (--order >= 0)
1810 goto retry;
1811
1812 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813}
1814
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815static void
1816sg_remove_scat(Sg_scatter_hold * schp)
1817{
1818 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001819 if (schp->pages && schp->sglist_len > 0) {
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001820 if (!schp->dio_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 int k;
1822
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001823 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 SCSI_LOG_TIMEOUT(5, printk(
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001825 "sg_remove_scat: k=%d, pg=0x%p\n",
1826 k, schp->pages[k]));
1827 __free_pages(schp->pages[k], schp->page_order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 }
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001829
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001830 kfree(schp->pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 }
Mike Christied6b10342005-11-08 04:06:41 -06001832 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 memset(schp, 0, sizeof (*schp));
1834}
1835
1836static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1838{
1839 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06001840 int k, num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841
1842 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1843 num_read_xfer));
1844 if ((!outp) || (num_read_xfer <= 0))
1845 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001847 num = 1 << (PAGE_SHIFT + schp->page_order);
1848 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001849 if (num > num_read_xfer) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001850 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001851 num_read_xfer))
1852 return -EFAULT;
1853 break;
1854 } else {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001855 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001856 num))
1857 return -EFAULT;
1858 num_read_xfer -= num;
1859 if (num_read_xfer <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 break;
Mike Christied6b10342005-11-08 04:06:41 -06001861 outp += num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 }
Mike Christied6b10342005-11-08 04:06:41 -06001864
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 return 0;
1866}
1867
1868static void
1869sg_build_reserve(Sg_fd * sfp, int req_size)
1870{
1871 Sg_scatter_hold *schp = &sfp->reserve;
1872
1873 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1874 do {
1875 if (req_size < PAGE_SIZE)
1876 req_size = PAGE_SIZE;
1877 if (0 == sg_build_indirect(schp, sfp, req_size))
1878 return;
1879 else
1880 sg_remove_scat(schp);
1881 req_size >>= 1; /* divide by 2 */
1882 } while (req_size > (PAGE_SIZE / 2));
1883}
1884
1885static void
1886sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1887{
1888 Sg_scatter_hold *req_schp = &srp->data;
1889 Sg_scatter_hold *rsv_schp = &sfp->reserve;
Mike Christied6b10342005-11-08 04:06:41 -06001890 int k, num, rem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
1892 srp->res_used = 1;
1893 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
Brian Kingeca7be52006-02-14 12:42:24 -06001894 rem = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001896 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1897 for (k = 0; k < rsv_schp->k_use_sg; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001898 if (rem <= num) {
Mike Christied6b10342005-11-08 04:06:41 -06001899 req_schp->k_use_sg = k + 1;
1900 req_schp->sglist_len = rsv_schp->sglist_len;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001901 req_schp->pages = rsv_schp->pages;
Mike Christied6b10342005-11-08 04:06:41 -06001902
1903 req_schp->bufflen = size;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001904 req_schp->page_order = rsv_schp->page_order;
Mike Christied6b10342005-11-08 04:06:41 -06001905 break;
1906 } else
1907 rem -= num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 }
Mike Christied6b10342005-11-08 04:06:41 -06001909
1910 if (k >= rsv_schp->k_use_sg)
1911 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912}
1913
1914static void
1915sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1916{
1917 Sg_scatter_hold *req_schp = &srp->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918
1919 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1920 (int) req_schp->k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 req_schp->k_use_sg = 0;
1922 req_schp->bufflen = 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001923 req_schp->pages = NULL;
1924 req_schp->page_order = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 req_schp->sglist_len = 0;
1926 sfp->save_scat_len = 0;
1927 srp->res_used = 0;
1928}
1929
1930static Sg_request *
1931sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1932{
1933 Sg_request *resp;
1934 unsigned long iflags;
1935
1936 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1937 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1938 /* look for requests that are ready + not SG_IO owned */
1939 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1940 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1941 resp->done = 2; /* guard against other readers */
1942 break;
1943 }
1944 }
1945 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1946 return resp;
1947}
1948
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949/* always adds to end of list */
1950static Sg_request *
1951sg_add_request(Sg_fd * sfp)
1952{
1953 int k;
1954 unsigned long iflags;
1955 Sg_request *resp;
1956 Sg_request *rp = sfp->req_arr;
1957
1958 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1959 resp = sfp->headrp;
1960 if (!resp) {
1961 memset(rp, 0, sizeof (Sg_request));
1962 rp->parentfp = sfp;
1963 resp = rp;
1964 sfp->headrp = resp;
1965 } else {
1966 if (0 == sfp->cmd_q)
1967 resp = NULL; /* command queuing disallowed */
1968 else {
1969 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
1970 if (!rp->parentfp)
1971 break;
1972 }
1973 if (k < SG_MAX_QUEUE) {
1974 memset(rp, 0, sizeof (Sg_request));
1975 rp->parentfp = sfp;
1976 while (resp->nextrp)
1977 resp = resp->nextrp;
1978 resp->nextrp = rp;
1979 resp = rp;
1980 } else
1981 resp = NULL;
1982 }
1983 }
1984 if (resp) {
1985 resp->nextrp = NULL;
cb59e842005-04-02 13:51:23 -06001986 resp->header.duration = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 }
1988 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1989 return resp;
1990}
1991
1992/* Return of 1 for found; 0 for not found */
1993static int
1994sg_remove_request(Sg_fd * sfp, Sg_request * srp)
1995{
1996 Sg_request *prev_rp;
1997 Sg_request *rp;
1998 unsigned long iflags;
1999 int res = 0;
2000
2001 if ((!sfp) || (!srp) || (!sfp->headrp))
2002 return res;
2003 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2004 prev_rp = sfp->headrp;
2005 if (srp == prev_rp) {
2006 sfp->headrp = prev_rp->nextrp;
2007 prev_rp->parentfp = NULL;
2008 res = 1;
2009 } else {
2010 while ((rp = prev_rp->nextrp)) {
2011 if (srp == rp) {
2012 prev_rp->nextrp = rp->nextrp;
2013 rp->parentfp = NULL;
2014 res = 1;
2015 break;
2016 }
2017 prev_rp = rp;
2018 }
2019 }
2020 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2021 return res;
2022}
2023
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024static Sg_fd *
2025sg_add_sfp(Sg_device * sdp, int dev)
2026{
2027 Sg_fd *sfp;
2028 unsigned long iflags;
Alan Stern44ec9542007-02-20 11:01:57 -05002029 int bufflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030
Mike Christied6b10342005-11-08 04:06:41 -06002031 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 if (!sfp)
2033 return NULL;
Mike Christied6b10342005-11-08 04:06:41 -06002034
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 init_waitqueue_head(&sfp->read_wait);
2036 rwlock_init(&sfp->rq_list_lock);
2037
Tony Battersbyc6517b792009-01-21 14:45:50 -05002038 kref_init(&sfp->f_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 sfp->timeout = SG_DEFAULT_TIMEOUT;
2040 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2041 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2042 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2043 sdp->device->host->unchecked_isa_dma : 1;
2044 sfp->cmd_q = SG_DEF_COMMAND_Q;
2045 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2046 sfp->parentdp = sdp;
James Bottomley7c07d612007-08-05 13:36:11 -05002047 write_lock_irqsave(&sg_index_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002048 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
James Bottomley7c07d612007-08-05 13:36:11 -05002049 write_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
Douglas Gilbert6460e752006-09-20 18:20:49 -04002051 if (unlikely(sg_big_buff != def_reserved_size))
2052 sg_big_buff = def_reserved_size;
2053
Alan Stern44ec9542007-02-20 11:01:57 -05002054 bufflen = min_t(int, sg_big_buff,
2055 sdp->device->request_queue->max_sectors * 512);
2056 sg_build_reserve(sfp, bufflen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2058 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
Tony Battersbyc6517b792009-01-21 14:45:50 -05002059
2060 kref_get(&sdp->d_ref);
2061 __module_get(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 return sfp;
2063}
2064
Tony Battersbyc6517b792009-01-21 14:45:50 -05002065static void sg_remove_sfp_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002067 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2068 struct sg_device *sdp = sfp->parentdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069
Tony Battersbyc6517b792009-01-21 14:45:50 -05002070 /* Cleanup any responses which were never read(). */
2071 while (sfp->headrp)
2072 sg_finish_rem_req(sfp->headrp);
2073
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 if (sfp->reserve.bufflen > 0) {
Tony Battersbyc6517b792009-01-21 14:45:50 -05002075 SCSI_LOG_TIMEOUT(6,
2076 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2077 (int) sfp->reserve.bufflen,
2078 (int) sfp->reserve.k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 sg_remove_scat(&sfp->reserve);
2080 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002081
2082 SCSI_LOG_TIMEOUT(6,
2083 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2084 sdp->disk->disk_name,
2085 sfp));
Mike Christied6b10342005-11-08 04:06:41 -06002086 kfree(sfp);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002087
2088 scsi_device_put(sdp->device);
2089 sg_put_dev(sdp);
2090 module_put(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091}
2092
Tony Battersbyc6517b792009-01-21 14:45:50 -05002093static void sg_remove_sfp(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002095 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2096 struct sg_device *sdp = sfp->parentdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002097 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
Tony Battersbyc6517b792009-01-21 14:45:50 -05002099 write_lock_irqsave(&sg_index_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002100 list_del(&sfp->sfd_siblings);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002101 write_unlock_irqrestore(&sg_index_lock, iflags);
2102 wake_up_interruptible(&sdp->o_excl_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
FUJITA Tomonori015640e2009-04-03 19:28:06 +09002104 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2105 schedule_work(&sfp->ew.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106}
2107
2108static int
2109sg_res_in_use(Sg_fd * sfp)
2110{
2111 const Sg_request *srp;
2112 unsigned long iflags;
2113
2114 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2115 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2116 if (srp->res_used)
2117 break;
2118 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2119 return srp ? 1 : 0;
2120}
2121
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122#ifdef CONFIG_SCSI_PROC_FS
2123static int
James Bottomley7c07d612007-08-05 13:36:11 -05002124sg_idr_max_id(int id, void *p, void *data)
2125{
2126 int *k = data;
2127
2128 if (*k < id)
2129 *k = id;
2130
2131 return 0;
2132}
2133
2134static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135sg_last_dev(void)
2136{
Tony Battersby53474c02008-01-22 15:25:49 -05002137 int k = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 unsigned long iflags;
2139
James Bottomley7c07d612007-08-05 13:36:11 -05002140 read_lock_irqsave(&sg_index_lock, iflags);
2141 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2142 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 return k + 1; /* origin 1 */
2144}
2145#endif
2146
Tony Battersbyc6517b792009-01-21 14:45:50 -05002147/* must be called with sg_index_lock held */
2148static Sg_device *sg_lookup_dev(int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002150 return idr_find(&sg_index_idr, dev);
2151}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152
Tony Battersbyc6517b792009-01-21 14:45:50 -05002153static Sg_device *sg_get_dev(int dev)
2154{
2155 struct sg_device *sdp;
2156 unsigned long flags;
2157
2158 read_lock_irqsave(&sg_index_lock, flags);
2159 sdp = sg_lookup_dev(dev);
2160 if (!sdp)
2161 sdp = ERR_PTR(-ENXIO);
2162 else if (sdp->detached) {
2163 /* If sdp->detached, then the refcount may already be 0, in
2164 * which case it would be a bug to do kref_get().
2165 */
2166 sdp = ERR_PTR(-ENODEV);
2167 } else
2168 kref_get(&sdp->d_ref);
2169 read_unlock_irqrestore(&sg_index_lock, flags);
James Bottomley7c07d612007-08-05 13:36:11 -05002170
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 return sdp;
2172}
2173
Tony Battersbyc6517b792009-01-21 14:45:50 -05002174static void sg_put_dev(struct sg_device *sdp)
2175{
2176 kref_put(&sdp->d_ref, sg_device_destroy);
2177}
2178
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179#ifdef CONFIG_SCSI_PROC_FS
2180
2181static struct proc_dir_entry *sg_proc_sgp = NULL;
2182
2183static char sg_proc_sg_dirname[] = "scsi/sg";
2184
2185static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2186
2187static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2188static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2189 size_t count, loff_t *off);
2190static struct file_operations adio_fops = {
2191 /* .owner, .read and .llseek added in sg_proc_init() */
2192 .open = sg_proc_single_open_adio,
2193 .write = sg_proc_write_adio,
2194 .release = single_release,
2195};
2196
2197static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2198static ssize_t sg_proc_write_dressz(struct file *filp,
2199 const char __user *buffer, size_t count, loff_t *off);
2200static struct file_operations dressz_fops = {
2201 .open = sg_proc_single_open_dressz,
2202 .write = sg_proc_write_dressz,
2203 .release = single_release,
2204};
2205
2206static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2207static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2208static struct file_operations version_fops = {
2209 .open = sg_proc_single_open_version,
2210 .release = single_release,
2211};
2212
2213static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2214static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2215static struct file_operations devhdr_fops = {
2216 .open = sg_proc_single_open_devhdr,
2217 .release = single_release,
2218};
2219
2220static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2221static int sg_proc_open_dev(struct inode *inode, struct file *file);
2222static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2223static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2224static void dev_seq_stop(struct seq_file *s, void *v);
2225static struct file_operations dev_fops = {
2226 .open = sg_proc_open_dev,
2227 .release = seq_release,
2228};
2229static struct seq_operations dev_seq_ops = {
2230 .start = dev_seq_start,
2231 .next = dev_seq_next,
2232 .stop = dev_seq_stop,
2233 .show = sg_proc_seq_show_dev,
2234};
2235
2236static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2237static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2238static struct file_operations devstrs_fops = {
2239 .open = sg_proc_open_devstrs,
2240 .release = seq_release,
2241};
2242static struct seq_operations devstrs_seq_ops = {
2243 .start = dev_seq_start,
2244 .next = dev_seq_next,
2245 .stop = dev_seq_stop,
2246 .show = sg_proc_seq_show_devstrs,
2247};
2248
2249static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2250static int sg_proc_open_debug(struct inode *inode, struct file *file);
2251static struct file_operations debug_fops = {
2252 .open = sg_proc_open_debug,
2253 .release = seq_release,
2254};
2255static struct seq_operations debug_seq_ops = {
2256 .start = dev_seq_start,
2257 .next = dev_seq_next,
2258 .stop = dev_seq_stop,
2259 .show = sg_proc_seq_show_debug,
2260};
2261
2262
2263struct sg_proc_leaf {
2264 const char * name;
2265 struct file_operations * fops;
2266};
2267
2268static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2269 {"allow_dio", &adio_fops},
2270 {"debug", &debug_fops},
2271 {"def_reserved_size", &dressz_fops},
2272 {"device_hdr", &devhdr_fops},
2273 {"devices", &dev_fops},
2274 {"device_strs", &devstrs_fops},
2275 {"version", &version_fops}
2276};
2277
2278static int
2279sg_proc_init(void)
2280{
2281 int k, mask;
Tobias Klauser6391a112006-06-08 22:23:48 -07002282 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 struct sg_proc_leaf * leaf;
2284
Al Viro66600222005-09-28 22:32:57 +01002285 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 if (!sg_proc_sgp)
2287 return 1;
2288 for (k = 0; k < num_leaves; ++k) {
2289 leaf = &sg_proc_leaf_arr[k];
2290 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
Denis V. Luneva9739092008-04-29 01:02:17 -07002291 leaf->fops->owner = THIS_MODULE;
2292 leaf->fops->read = seq_read;
2293 leaf->fops->llseek = seq_lseek;
2294 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 }
2296 return 0;
2297}
2298
2299static void
2300sg_proc_cleanup(void)
2301{
2302 int k;
Tobias Klauser6391a112006-06-08 22:23:48 -07002303 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304
2305 if (!sg_proc_sgp)
2306 return;
2307 for (k = 0; k < num_leaves; ++k)
2308 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2309 remove_proc_entry(sg_proc_sg_dirname, NULL);
2310}
2311
2312
2313static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2314{
2315 seq_printf(s, "%d\n", *((int *)s->private));
2316 return 0;
2317}
2318
2319static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2320{
2321 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2322}
2323
2324static ssize_t
2325sg_proc_write_adio(struct file *filp, const char __user *buffer,
2326 size_t count, loff_t *off)
2327{
2328 int num;
2329 char buff[11];
2330
2331 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2332 return -EACCES;
2333 num = (count < 10) ? count : 10;
2334 if (copy_from_user(buff, buffer, num))
2335 return -EFAULT;
2336 buff[num] = '\0';
2337 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2338 return count;
2339}
2340
2341static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2342{
2343 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2344}
2345
2346static ssize_t
2347sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2348 size_t count, loff_t *off)
2349{
2350 int num;
2351 unsigned long k = ULONG_MAX;
2352 char buff[11];
2353
2354 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2355 return -EACCES;
2356 num = (count < 10) ? count : 10;
2357 if (copy_from_user(buff, buffer, num))
2358 return -EFAULT;
2359 buff[num] = '\0';
2360 k = simple_strtoul(buff, NULL, 10);
2361 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2362 sg_big_buff = k;
2363 return count;
2364 }
2365 return -ERANGE;
2366}
2367
2368static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2369{
2370 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2371 sg_version_date);
2372 return 0;
2373}
2374
2375static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2376{
2377 return single_open(file, sg_proc_seq_show_version, NULL);
2378}
2379
2380static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2381{
2382 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2383 "online\n");
2384 return 0;
2385}
2386
2387static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2388{
2389 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2390}
2391
2392struct sg_proc_deviter {
2393 loff_t index;
2394 size_t max;
2395};
2396
2397static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2398{
2399 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2400
Jan Blunck729d70f2005-08-27 11:07:52 -07002401 s->private = it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 if (! it)
2403 return NULL;
Jan Blunck729d70f2005-08-27 11:07:52 -07002404
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 it->index = *pos;
2406 it->max = sg_last_dev();
2407 if (it->index >= it->max)
Jan Blunck729d70f2005-08-27 11:07:52 -07002408 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 return it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410}
2411
2412static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2413{
Jan Blunck729d70f2005-08-27 11:07:52 -07002414 struct sg_proc_deviter * it = s->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415
2416 *pos = ++it->index;
2417 return (it->index < it->max) ? it : NULL;
2418}
2419
2420static void dev_seq_stop(struct seq_file *s, void *v)
2421{
Jan Blunck729d70f2005-08-27 11:07:52 -07002422 kfree(s->private);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423}
2424
2425static int sg_proc_open_dev(struct inode *inode, struct file *file)
2426{
2427 return seq_open(file, &dev_seq_ops);
2428}
2429
2430static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2431{
2432 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2433 Sg_device *sdp;
2434 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002435 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
Tony Battersbyc6517b792009-01-21 14:45:50 -05002437 read_lock_irqsave(&sg_index_lock, iflags);
2438 sdp = it ? sg_lookup_dev(it->index) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2440 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2441 scsidp->host->host_no, scsidp->channel,
2442 scsidp->id, scsidp->lun, (int) scsidp->type,
2443 1,
2444 (int) scsidp->queue_depth,
2445 (int) scsidp->device_busy,
2446 (int) scsi_device_online(scsidp));
2447 else
2448 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002449 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 return 0;
2451}
2452
2453static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2454{
2455 return seq_open(file, &devstrs_seq_ops);
2456}
2457
2458static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2459{
2460 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2461 Sg_device *sdp;
2462 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002463 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
Tony Battersbyc6517b792009-01-21 14:45:50 -05002465 read_lock_irqsave(&sg_index_lock, iflags);
2466 sdp = it ? sg_lookup_dev(it->index) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2468 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2469 scsidp->vendor, scsidp->model, scsidp->rev);
2470 else
2471 seq_printf(s, "<no active device>\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002472 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 return 0;
2474}
2475
Tony Battersbyc6517b792009-01-21 14:45:50 -05002476/* must be called while holding sg_index_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2478{
2479 int k, m, new_interface, blen, usg;
2480 Sg_request *srp;
2481 Sg_fd *fp;
2482 const sg_io_hdr_t *hp;
2483 const char * cp;
cb59e842005-04-02 13:51:23 -06002484 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002486 k = 0;
2487 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2488 k++;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002489 read_lock(&fp->rq_list_lock); /* irqs already disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002491 "(res)sgat=%d low_dma=%d\n", k,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 jiffies_to_msecs(fp->timeout),
2493 fp->reserve.bufflen,
2494 (int) fp->reserve.k_use_sg,
2495 (int) fp->low_dma);
2496 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2497 (int) fp->cmd_q, (int) fp->force_packid,
2498 (int) fp->keep_orphan, (int) fp->closed);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002499 for (m = 0, srp = fp->headrp;
2500 srp != NULL;
2501 ++m, srp = srp->nextrp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502 hp = &srp->header;
2503 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2504 if (srp->res_used) {
2505 if (new_interface &&
2506 (SG_FLAG_MMAP_IO & hp->flags))
2507 cp = " mmap>> ";
2508 else
2509 cp = " rb>> ";
2510 } else {
2511 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2512 cp = " dio>> ";
2513 else
2514 cp = " ";
2515 }
2516 seq_printf(s, cp);
Mike Christied6b10342005-11-08 04:06:41 -06002517 blen = srp->data.bufflen;
2518 usg = srp->data.k_use_sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519 seq_printf(s, srp->done ?
2520 ((1 == srp->done) ? "rcv:" : "fin:")
Mike Christied6b10342005-11-08 04:06:41 -06002521 : "act:");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 seq_printf(s, " id=%d blen=%d",
2523 srp->header.pack_id, blen);
2524 if (srp->done)
2525 seq_printf(s, " dur=%d", hp->duration);
cb59e842005-04-02 13:51:23 -06002526 else {
2527 ms = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 seq_printf(s, " t_o/elap=%d/%d",
cb59e842005-04-02 13:51:23 -06002529 (new_interface ? hp->timeout :
2530 jiffies_to_msecs(fp->timeout)),
2531 (ms > hp->duration ? ms - hp->duration : 0));
2532 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2534 (int) srp->data.cmd_opcode);
2535 }
2536 if (0 == m)
2537 seq_printf(s, " No requests active\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002538 read_unlock(&fp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 }
2540}
2541
2542static int sg_proc_open_debug(struct inode *inode, struct file *file)
2543{
2544 return seq_open(file, &debug_seq_ops);
2545}
2546
2547static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2548{
2549 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2550 Sg_device *sdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002551 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552
2553 if (it && (0 == it->index)) {
James Bottomley7c07d612007-08-05 13:36:11 -05002554 seq_printf(s, "max_active_device=%d(origin 1)\n",
2555 (int)it->max);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2557 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002558
2559 read_lock_irqsave(&sg_index_lock, iflags);
2560 sdp = it ? sg_lookup_dev(it->index) : NULL;
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002561 if (sdp && !list_empty(&sdp->sfds)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 struct scsi_device *scsidp = sdp->device;
2563
Tony Battersbyc6517b792009-01-21 14:45:50 -05002564 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2565 if (sdp->detached)
2566 seq_printf(s, "detached pending close ");
2567 else
2568 seq_printf
2569 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2570 scsidp->host->host_no,
2571 scsidp->channel, scsidp->id,
2572 scsidp->lun,
2573 scsidp->host->hostt->emulated);
2574 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2575 sdp->sg_tablesize, sdp->exclude);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 sg_proc_debug_helper(s, sdp);
2577 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002578 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 return 0;
2580}
2581
2582#endif /* CONFIG_SCSI_PROC_FS */
2583
2584module_init(init_sg);
2585module_exit(exit_sg);