projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[SCSI] sg: protect sdp->exclude
[deliverable/linux.git] / drivers / scsi / sg.c
CommitLineData
1da177e4
LT		 1/*
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
b2155d04
DG		 21static int sg_version_num = 30534; /* 2 digits for each component */
22#define SG_VERSION_STR "3.5.34"
1da177e4
LT		 23
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 */
1da177e4
LT		 31#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>
5a0e3ad6 41#include <linux/slab.h>
1da177e4
LT		 42#include <linux/fcntl.h>
43#include <linux/init.h>
44#include <linux/poll.h>
1da177e4 45#include <linux/moduleparam.h>
1da177e4 46#include <linux/cdev.h>
7c07d613 47#include <linux/idr.h>
1da177e4
LT		 48#include <linux/seq_file.h>
49#include <linux/blkdev.h>
50#include <linux/delay.h>
6da127ad 51#include <linux/blktrace_api.h>
c45d15d2 52#include <linux/mutex.h>
2fe038e3 53#include <linux/ratelimit.h>
1da177e4
LT		 54
55#include "scsi.h"
db9dff36 56#include <scsi/scsi_dbg.h>
1da177e4
LT		 57#include <scsi/scsi_host.h>
58#include <scsi/scsi_driver.h>
59#include <scsi/scsi_ioctl.h>
60#include <scsi/sg.h>
61
62#include "scsi_logging.h"
63
64#ifdef CONFIG_SCSI_PROC_FS
65#include <linux/proc_fs.h>
7ca63cb4 66static char *sg_version_date = "20061027";
1da177e4
LT		 67
68static int sg_proc_init(void);
69static void sg_proc_cleanup(void);
70#endif
71
1da177e4 72#define SG_ALLOW_DIO_DEF 0
1da177e4
LT		 73
74#define SG_MAX_DEVS 32768
75
76/*
77 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
78 * Then when using 32 bit integers x * m may overflow during the calculation.
79 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
80 * calculates the same, but prevents the overflow when both m and d
81 * are "small" numbers (like HZ and USER_HZ).
82 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
83 * in 32 bits.
84 */
85#define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
86
87#define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
88
89int sg_big_buff = SG_DEF_RESERVED_SIZE;
90/* N.B. This variable is readable and writeable via
91 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
92 of this size (or less if there is not enough memory) will be reserved
93 for use by this file descriptor. [Deprecated usage: this variable is also
94 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
95 the kernel (i.e. it is not a module).] */
96static int def_reserved_size = -1; /* picks up init parameter */
97static int sg_allow_dio = SG_ALLOW_DIO_DEF;
98
6460e75a
DG		 99static int scatter_elem_sz = SG_SCATTER_SZ;
100static int scatter_elem_sz_prev = SG_SCATTER_SZ;
101
1da177e4 102#define SG_SECTOR_SZ 512
1da177e4 103
ee959b00
TJ		 104static int sg_add(struct device *, struct class_interface *);
105static void sg_remove(struct device *, struct class_interface *);
1da177e4 106
c45d15d2 107static DEFINE_MUTEX(sg_mutex);
b499e524 108static DEFINE_SPINLOCK(sg_open_exclusive_lock);
c45d15d2 109
7c07d613
JB		 110static DEFINE_IDR(sg_index_idr);
111static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
1da177e4
LT		 112 file descriptor list for device */
113
114static struct class_interface sg_interface = {
ee959b00
TJ		 115 .add_dev = sg_add,
116 .remove_dev = sg_remove,
1da177e4
LT		 117};
118
119typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
120 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
ea312552 121 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
1da177e4 122 unsigned bufflen; /* Size of (aggregate) data buffer */
10db10d1
FT		 123 struct page **pages;
124 int page_order;
1da177e4
LT		 125 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
126 unsigned char cmd_opcode; /* first byte of command */
127} Sg_scatter_hold;
128
129struct sg_device; /* forward declarations */
130struct sg_fd;
131
132typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
1da177e4
LT		 133 struct sg_request *nextrp; /* NULL -> tail request (slist) */
134 struct sg_fd *parentfp; /* NULL -> not in use */
135 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
136 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
d6b10348 137 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
1da177e4
LT		 138 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
139 char orphan; /* 1 -> drop on sight, 0 -> normal */
140 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
6acddc5e
JE		 141 /* done protected by rq_list_lock */
142 char done; /* 0->before bh, 1->before read, 2->read */
10865dfa 143 struct request *rq;
6e5a30cb 144 struct bio *bio;
c96952ed 145 struct execute_work ew;
1da177e4
LT		 146} Sg_request;
147
148typedef struct sg_fd { /* holds the state of a file descriptor */
3442f802 149 struct list_head sfd_siblings;
1da177e4
LT		 150 struct sg_device *parentdp; /* owning device */
151 wait_queue_head_t read_wait; /* queue read until command done */
152 rwlock_t rq_list_lock; /* protect access to list in req_arr */
153 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
154 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
155 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
156 unsigned save_scat_len; /* original length of trunc. scat. element */
157 Sg_request *headrp; /* head of request slist, NULL->empty */
158 struct fasync_struct *async_qp; /* used by asynchronous notification */
159 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
160 char low_dma; /* as in parent but possibly overridden to 1 */
161 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
1da177e4
LT		 162 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
163 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
164 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
165 char mmap_called; /* 0 -> mmap() never called on this fd */
c6517b79
TB		 166 struct kref f_ref;
167 struct execute_work ew;
1da177e4
LT		 168} Sg_fd;
169
170typedef struct sg_device { /* holds the state of each scsi generic device */
171 struct scsi_device *device;
172 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
173 int sg_tablesize; /* adapter's max scatter-gather table size */
7c07d613 174 u32 index; /* device index number */
3442f802 175 struct list_head sfds;
1da177e4 176 volatile char detached; /* 0->attached, 1->detached pending removal */
b499e524
JE		 177 /* exclude protected by sg_open_exclusive_lock */
178 char exclude; /* opened for exclusive access */
1da177e4
LT		 179 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
180 struct gendisk *disk;
181 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
c6517b79 182 struct kref d_ref;
1da177e4
LT		 183} Sg_device;
184
d6b10348 185/* tasklet or soft irq callback */
a91a3a20 186static void sg_rq_end_io(struct request *rq, int uptodate);
10865dfa 187static int sg_start_req(Sg_request *srp, unsigned char *cmd);
e7ee4cc0 188static int sg_finish_rem_req(Sg_request * srp);
1da177e4 189static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
1da177e4
LT		 190static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
191 Sg_request * srp);
0b07de85
AG		 192static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
193 const char __user *buf, size_t count, int blocking,
a2dd3b4c 194 int read_only, int sg_io_owned, Sg_request **o_srp);
1da177e4
LT		 195static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
196 unsigned char *cmnd, int timeout, int blocking);
1da177e4
LT		 197static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
198static void sg_remove_scat(Sg_scatter_hold * schp);
199static void sg_build_reserve(Sg_fd * sfp, int req_size);
200static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
201static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
1da177e4 202static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
c6517b79 203static void sg_remove_sfp(struct kref *);
1da177e4
LT		 204static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
205static Sg_request *sg_add_request(Sg_fd * sfp);
206static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
207static int sg_res_in_use(Sg_fd * sfp);
1da177e4 208static Sg_device *sg_get_dev(int dev);
c6517b79 209static void sg_put_dev(Sg_device *sdp);
1da177e4 210
1da177e4
LT		 211#define SZ_SG_HEADER sizeof(struct sg_header)
212#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
213#define SZ_SG_IOVEC sizeof(sg_iovec_t)
214#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
215
14e507b8
FT		 216static int sg_allow_access(struct file *filp, unsigned char *cmd)
217{
35df8397 218 struct sg_fd *sfp = filp->private_data;
14e507b8
FT		 219
220 if (sfp->parentdp->device->type == TYPE_SCANNER)
221 return 0;
222
018e0446 223 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
14e507b8
FT		 224}
225
b499e524
JE		 226static int get_exclude(Sg_device *sdp)
227{
228 unsigned long flags;
229 int ret;
230
231 spin_lock_irqsave(&sg_open_exclusive_lock, flags);
232 ret = sdp->exclude;
233 spin_unlock_irqrestore(&sg_open_exclusive_lock, flags);
234 return ret;
235}
236
237static int set_exclude(Sg_device *sdp, char val)
238{
239 unsigned long flags;
240
241 spin_lock_irqsave(&sg_open_exclusive_lock, flags);
242 sdp->exclude = val;
243 spin_unlock_irqrestore(&sg_open_exclusive_lock, flags);
244 return val;
245}
246
1da177e4
LT		 247static int
248sg_open(struct inode *inode, struct file *filp)
249{
250 int dev = iminor(inode);
251 int flags = filp->f_flags;
d6b10348 252 struct request_queue *q;
1da177e4
LT		 253 Sg_device *sdp;
254 Sg_fd *sfp;
255 int res;
256 int retval;
257
c45d15d2 258 mutex_lock(&sg_mutex);
1da177e4
LT		 259 nonseekable_open(inode, filp);
260 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
261 sdp = sg_get_dev(dev);
c6517b79
TB		 262 if (IS_ERR(sdp)) {
263 retval = PTR_ERR(sdp);
264 sdp = NULL;
265 goto sg_put;
eb09d3d4 266 }
1da177e4
LT		 267
268 /* This driver's module count bumped by fops_get in <linux/fs.h> */
269 /* Prevent the device driver from vanishing while we sleep */
270 retval = scsi_device_get(sdp->device);
c6517b79
TB		 271 if (retval)
272 goto sg_put;
1da177e4 273
bc4f2401
AS		 274 retval = scsi_autopm_get_device(sdp->device);
275 if (retval)
276 goto sdp_put;
277
1da177e4
LT		 278 if (!((flags & O_NONBLOCK) ||
279 scsi_block_when_processing_errors(sdp->device))) {
280 retval = -ENXIO;
281 /* we are in error recovery for this device */
282 goto error_out;
283 }
284
285 if (flags & O_EXCL) {
286 if (O_RDONLY == (flags & O_ACCMODE)) {
287 retval = -EPERM; /* Can't lock it with read only access */
288 goto error_out;
289 }
3442f802 290 if (!list_empty(&sdp->sfds) && (flags & O_NONBLOCK)) {
1da177e4
LT		 291 retval = -EBUSY;
292 goto error_out;
293 }
3f0c6aba 294 res = wait_event_interruptible(sdp->o_excl_wait,
b499e524 295 ((!list_empty(&sdp->sfds) || get_exclude(sdp)) ? 0 : set_exclude(sdp, 1)));
1da177e4
LT		 296 if (res) {
297 retval = res; /* -ERESTARTSYS because signal hit process */
298 goto error_out;
299 }
b499e524 300 } else if (get_exclude(sdp)) { /* some other fd has an exclusive lock on dev */
1da177e4
LT		 301 if (flags & O_NONBLOCK) {
302 retval = -EBUSY;
303 goto error_out;
304 }
b499e524 305 res = wait_event_interruptible(sdp->o_excl_wait, !get_exclude(sdp));
1da177e4
LT		 306 if (res) {
307 retval = res; /* -ERESTARTSYS because signal hit process */
308 goto error_out;
309 }
310 }
311 if (sdp->detached) {
312 retval = -ENODEV;
313 goto error_out;
314 }
3442f802 315 if (list_empty(&sdp->sfds)) { /* no existing opens on this device */
1da177e4 316 sdp->sgdebug = 0;
d6b10348 317 q = sdp->device->request_queue;
8a78362c 318 sdp->sg_tablesize = queue_max_segments(q);
1da177e4
LT		 319 }
320 if ((sfp = sg_add_sfp(sdp, dev)))
321 filp->private_data = sfp;
322 else {
c6517b79 323 if (flags & O_EXCL) {
b499e524 324 set_exclude(sdp, 0); /* undo if error */
c6517b79
TB		 325 wake_up_interruptible(&sdp->o_excl_wait);
326 }
1da177e4
LT		 327 retval = -ENOMEM;
328 goto error_out;
329 }
c6517b79
TB		 330 retval = 0;
331error_out:
bc4f2401
AS		 332 if (retval) {
333 scsi_autopm_put_device(sdp->device);
334sdp_put:
c6517b79 335 scsi_device_put(sdp->device);
bc4f2401 336 }
c6517b79
TB		 337sg_put:
338 if (sdp)
339 sg_put_dev(sdp);
c45d15d2 340 mutex_unlock(&sg_mutex);
1da177e4
LT		 341 return retval;
342}
343
344/* Following function was formerly called 'sg_close' */
345static int
346sg_release(struct inode *inode, struct file *filp)
347{
348 Sg_device *sdp;
349 Sg_fd *sfp;
350
351 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
352 return -ENXIO;
353 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
c6517b79 354
b499e524 355 set_exclude(sdp, 0);
c6517b79
TB		 356 wake_up_interruptible(&sdp->o_excl_wait);
357
bc4f2401 358 scsi_autopm_put_device(sdp->device);
c6517b79 359 kref_put(&sfp->f_ref, sg_remove_sfp);
1da177e4
LT		 360 return 0;
361}
362
363static ssize_t
364sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
365{
1da177e4
LT		 366 Sg_device *sdp;
367 Sg_fd *sfp;
368 Sg_request *srp;
369 int req_pack_id = -1;
1da177e4 370 sg_io_hdr_t *hp;
cb59e840 371 struct sg_header *old_hdr = NULL;
372 int retval = 0;
1da177e4
LT		 373
374 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
375 return -ENXIO;
376 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
377 sdp->disk->disk_name, (int) count));
d6b10348 378
1da177e4
LT		 379 if (!access_ok(VERIFY_WRITE, buf, count))
380 return -EFAULT;
381 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
cb59e840 382 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
383 if (!old_hdr)
384 return -ENOMEM;
385 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
386 retval = -EFAULT;
387 goto free_old_hdr;
388 }
389 if (old_hdr->reply_len < 0) {
1da177e4 390 if (count >= SZ_SG_IO_HDR) {
cb59e840 391 sg_io_hdr_t *new_hdr;
392 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
393 if (!new_hdr) {
394 retval = -ENOMEM;
395 goto free_old_hdr;
396 }
397 retval =__copy_from_user
398 (new_hdr, buf, SZ_SG_IO_HDR);
399 req_pack_id = new_hdr->pack_id;
400 kfree(new_hdr);
401 if (retval) {
402 retval = -EFAULT;
403 goto free_old_hdr;
404 }
1da177e4
LT		 405 }
406 } else
cb59e840 407 req_pack_id = old_hdr->pack_id;
1da177e4
LT		 408 }
409 srp = sg_get_rq_mark(sfp, req_pack_id);
410 if (!srp) { /* now wait on packet to arrive */
cb59e840 411 if (sdp->detached) {
412 retval = -ENODEV;
413 goto free_old_hdr;
414 }
415 if (filp->f_flags & O_NONBLOCK) {
416 retval = -EAGAIN;
417 goto free_old_hdr;
418 }
3f0c6aba 419 retval = wait_event_interruptible(sfp->read_wait,
794c10fa 420 (sdp->detached ||
3f0c6aba 421 (srp = sg_get_rq_mark(sfp, req_pack_id))));
794c10fa
JE		 422 if (sdp->detached) {
423 retval = -ENODEV;
424 goto free_old_hdr;
425 }
426 if (retval) {
cb59e840 427 /* -ERESTARTSYS as signal hit process */
428 goto free_old_hdr;
1da177e4
LT		 429 }
430 }
cb59e840 431 if (srp->header.interface_id != '\0') {
432 retval = sg_new_read(sfp, buf, count, srp);
433 goto free_old_hdr;
434 }
1da177e4
LT		 435
436 hp = &srp->header;
cb59e840 437 if (old_hdr == NULL) {
438 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
439 if (! old_hdr) {
440 retval = -ENOMEM;
441 goto free_old_hdr;
442 }
443 }
444 memset(old_hdr, 0, SZ_SG_HEADER);
445 old_hdr->reply_len = (int) hp->timeout;
446 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
447 old_hdr->pack_id = hp->pack_id;
448 old_hdr->twelve_byte =
1da177e4 449 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
cb59e840 450 old_hdr->target_status = hp->masked_status;
451 old_hdr->host_status = hp->host_status;
452 old_hdr->driver_status = hp->driver_status;
1da177e4
LT		 453 if ((CHECK_CONDITION & hp->masked_status) ||
454 (DRIVER_SENSE & hp->driver_status))
cb59e840 455 memcpy(old_hdr->sense_buffer, srp->sense_b,
456 sizeof (old_hdr->sense_buffer));
1da177e4
LT		 457 switch (hp->host_status) {
458 /* This setup of 'result' is for backward compatibility and is best
459 ignored by the user who should use target, host + driver status */
460 case DID_OK:
461 case DID_PASSTHROUGH:
462 case DID_SOFT_ERROR:
cb59e840 463 old_hdr->result = 0;
1da177e4
LT		 464 break;
465 case DID_NO_CONNECT:
466 case DID_BUS_BUSY:
467 case DID_TIME_OUT:
cb59e840 468 old_hdr->result = EBUSY;
1da177e4
LT		 469 break;
470 case DID_BAD_TARGET:
471 case DID_ABORT:
472 case DID_PARITY:
473 case DID_RESET:
474 case DID_BAD_INTR:
cb59e840 475 old_hdr->result = EIO;
1da177e4
LT		 476 break;
477 case DID_ERROR:
cb59e840 478 old_hdr->result = (srp->sense_b[0] == 0 &&
1da177e4
LT		 479 hp->masked_status == GOOD) ? 0 : EIO;
480 break;
481 default:
cb59e840 482 old_hdr->result = EIO;
1da177e4
LT		 483 break;
484 }
485
486 /* Now copy the result back to the user buffer. */
487 if (count >= SZ_SG_HEADER) {
cb59e840 488 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
489 retval = -EFAULT;
490 goto free_old_hdr;
491 }
1da177e4 492 buf += SZ_SG_HEADER;
cb59e840 493 if (count > old_hdr->reply_len)
494 count = old_hdr->reply_len;
1da177e4 495 if (count > SZ_SG_HEADER) {
cb59e840 496 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
497 retval = -EFAULT;
498 goto free_old_hdr;
499 }
1da177e4
LT		 500 }
501 } else
cb59e840 502 count = (old_hdr->result == 0) ? 0 : -EIO;
1da177e4 503 sg_finish_rem_req(srp);
cb59e840 504 retval = count;
505free_old_hdr:
c9475cb0 506 kfree(old_hdr);
cb59e840 507 return retval;
1da177e4
LT		 508}
509
510static ssize_t
511sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
512{
513 sg_io_hdr_t *hp = &srp->header;
514 int err = 0;
515 int len;
516
517 if (count < SZ_SG_IO_HDR) {
518 err = -EINVAL;
519 goto err_out;
520 }
521 hp->sb_len_wr = 0;
522 if ((hp->mx_sb_len > 0) && hp->sbp) {
523 if ((CHECK_CONDITION & hp->masked_status) ||
524 (DRIVER_SENSE & hp->driver_status)) {
d6b10348 525 int sb_len = SCSI_SENSE_BUFFERSIZE;
1da177e4
LT		 526 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
527 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
528 len = (len > sb_len) ? sb_len : len;
529 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
530 err = -EFAULT;
531 goto err_out;
532 }
533 hp->sb_len_wr = len;
534 }
535 }
536 if (hp->masked_status || hp->host_status || hp->driver_status)
537 hp->info |= SG_INFO_CHECK;
538 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
539 err = -EFAULT;
540 goto err_out;
541 }
0b6cb26c 542err_out:
e7ee4cc0 543 err = sg_finish_rem_req(srp);
1da177e4
LT		 544 return (0 == err) ? count : err;
545}
546
547static ssize_t
548sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
549{
550 int mxsize, cmd_size, k;
551 int input_size, blocking;
552 unsigned char opcode;
553 Sg_device *sdp;
554 Sg_fd *sfp;
555 Sg_request *srp;
556 struct sg_header old_hdr;
557 sg_io_hdr_t *hp;
d6b10348 558 unsigned char cmnd[MAX_COMMAND_SIZE];
1da177e4
LT		 559
560 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
561 return -ENXIO;
562 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
563 sdp->disk->disk_name, (int) count));
564 if (sdp->detached)
565 return -ENODEV;
566 if (!((filp->f_flags & O_NONBLOCK) ||
567 scsi_block_when_processing_errors(sdp->device)))
568 return -ENXIO;
569
570 if (!access_ok(VERIFY_READ, buf, count))
571 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
572 if (count < SZ_SG_HEADER)
573 return -EIO;
574 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
575 return -EFAULT;
576 blocking = !(filp->f_flags & O_NONBLOCK);
577 if (old_hdr.reply_len < 0)
a2dd3b4c
TB		 578 return sg_new_write(sfp, filp, buf, count,
579 blocking, 0, 0, NULL);
1da177e4
LT		 580 if (count < (SZ_SG_HEADER + 6))
581 return -EIO; /* The minimum scsi command length is 6 bytes. */
582
583 if (!(srp = sg_add_request(sfp))) {
584 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
585 return -EDOM;
586 }
587 buf += SZ_SG_HEADER;
588 __get_user(opcode, buf);
589 if (sfp->next_cmd_len > 0) {
590 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
591 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
592 sfp->next_cmd_len = 0;
593 sg_remove_request(sfp, srp);
594 return -EIO;
595 }
596 cmd_size = sfp->next_cmd_len;
597 sfp->next_cmd_len = 0; /* reset so only this write() effected */
598 } else {
599 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
600 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
601 cmd_size = 12;
602 }
603 SCSI_LOG_TIMEOUT(4, printk(
604 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
605/* Determine buffer size. */
606 input_size = count - cmd_size;
607 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
608 mxsize -= SZ_SG_HEADER;
609 input_size -= SZ_SG_HEADER;
610 if (input_size < 0) {
611 sg_remove_request(sfp, srp);
612 return -EIO; /* User did not pass enough bytes for this command. */
613 }
614 hp = &srp->header;
615 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
616 hp->cmd_len = (unsigned char) cmd_size;
617 hp->iovec_count = 0;
618 hp->mx_sb_len = 0;
619 if (input_size > 0)
620 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
621 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
622 else
623 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
624 hp->dxfer_len = mxsize;
fad7f01e
FT		 625 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
626 hp->dxferp = (char __user *)buf + cmd_size;
627 else
628 hp->dxferp = NULL;
1da177e4
LT		 629 hp->sbp = NULL;
630 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
631 hp->flags = input_size; /* structure abuse ... */
632 hp->pack_id = old_hdr.pack_id;
633 hp->usr_ptr = NULL;
634 if (__copy_from_user(cmnd, buf, cmd_size))
635 return -EFAULT;
636 /*
637 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
638 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
639 * is a non-zero input_size, so emit a warning.
640 */
eaa3e22e
AK		 641 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
642 static char cmd[TASK_COMM_LEN];
2fe038e3
CD		 643 if (strcmp(current->comm, cmd)) {
644 printk_ratelimited(KERN_WARNING
645 "sg_write: data in/out %d/%d bytes "
646 "for SCSI command 0x%x-- guessing "
647 "data in;\n program %s not setting "
648 "count and/or reply_len properly\n",
649 old_hdr.reply_len - (int)SZ_SG_HEADER,
650 input_size, (unsigned int) cmnd[0],
651 current->comm);
eaa3e22e
AK		 652 strcpy(cmd, current->comm);
653 }
654 }
1da177e4
LT		 655 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
656 return (k < 0) ? k : count;
657}
658
659static ssize_t
0b07de85 660sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
a2dd3b4c 661 size_t count, int blocking, int read_only, int sg_io_owned,
0b07de85 662 Sg_request **o_srp)
1da177e4
LT		 663{
664 int k;
665 Sg_request *srp;
666 sg_io_hdr_t *hp;
d6b10348 667 unsigned char cmnd[MAX_COMMAND_SIZE];
1da177e4
LT		 668 int timeout;
669 unsigned long ul_timeout;
670
671 if (count < SZ_SG_IO_HDR)
672 return -EINVAL;
673 if (!access_ok(VERIFY_READ, buf, count))
674 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
675
676 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
677 if (!(srp = sg_add_request(sfp))) {
678 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
679 return -EDOM;
680 }
a2dd3b4c 681 srp->sg_io_owned = sg_io_owned;
1da177e4
LT		 682 hp = &srp->header;
683 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
684 sg_remove_request(sfp, srp);
685 return -EFAULT;
686 }
687 if (hp->interface_id != 'S') {
688 sg_remove_request(sfp, srp);
689 return -ENOSYS;
690 }
691 if (hp->flags & SG_FLAG_MMAP_IO) {
692 if (hp->dxfer_len > sfp->reserve.bufflen) {
693 sg_remove_request(sfp, srp);
694 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
695 }
696 if (hp->flags & SG_FLAG_DIRECT_IO) {
697 sg_remove_request(sfp, srp);
698 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
699 }
700 if (sg_res_in_use(sfp)) {
701 sg_remove_request(sfp, srp);
702 return -EBUSY; /* reserve buffer already being used */
703 }
704 }
705 ul_timeout = msecs_to_jiffies(srp->header.timeout);
706 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
707 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
708 sg_remove_request(sfp, srp);
709 return -EMSGSIZE;
710 }
711 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
712 sg_remove_request(sfp, srp);
713 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
714 }
715 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
716 sg_remove_request(sfp, srp);
717 return -EFAULT;
718 }
14e507b8 719 if (read_only && sg_allow_access(file, cmnd)) {
1da177e4
LT		 720 sg_remove_request(sfp, srp);
721 return -EPERM;
722 }
723 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
724 if (k < 0)
725 return k;
726 if (o_srp)
727 *o_srp = srp;
728 return count;
729}
730
731static int
732sg_common_write(Sg_fd * sfp, Sg_request * srp,
733 unsigned char *cmnd, int timeout, int blocking)
734{
d6b10348 735 int k, data_dir;
1da177e4
LT		 736 Sg_device *sdp = sfp->parentdp;
737 sg_io_hdr_t *hp = &srp->header;
1da177e4
LT		 738
739 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
740 hp->status = 0;
741 hp->masked_status = 0;
742 hp->msg_status = 0;
743 hp->info = 0;
744 hp->host_status = 0;
745 hp->driver_status = 0;
746 hp->resid = 0;
747 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
748 (int) cmnd[0], (int) hp->cmd_len));
749
10865dfa
FT		 750 k = sg_start_req(srp, cmnd);
751 if (k) {
7ca63cb4 752 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
1da177e4
LT		 753 sg_finish_rem_req(srp);
754 return k; /* probably out of space --> ENOMEM */
755 }
1da177e4 756 if (sdp->detached) {
caf19d38
FT		 757 if (srp->bio)
758 blk_end_request_all(srp->rq, -EIO);
1da177e4
LT		 759 sg_finish_rem_req(srp);
760 return -ENODEV;
761 }
1da177e4 762
1da177e4
LT		 763 switch (hp->dxfer_direction) {
764 case SG_DXFER_TO_FROM_DEV:
765 case SG_DXFER_FROM_DEV:
d6b10348 766 data_dir = DMA_FROM_DEVICE;
1da177e4
LT		 767 break;
768 case SG_DXFER_TO_DEV:
d6b10348 769 data_dir = DMA_TO_DEVICE;
1da177e4
LT		 770 break;
771 case SG_DXFER_UNKNOWN:
d6b10348 772 data_dir = DMA_BIDIRECTIONAL;
1da177e4
LT		 773 break;
774 default:
d6b10348 775 data_dir = DMA_NONE;
1da177e4
LT		 776 break;
777 }
cb59e840 778 hp->duration = jiffies_to_msecs(jiffies);
10db10d1
FT		 779
780 srp->rq->timeout = timeout;
c6517b79 781 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
10db10d1
FT		 782 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
783 srp->rq, 1, sg_rq_end_io);
784 return 0;
1da177e4
LT		 785}
786
6acddc5e
JE		 787static int srp_done(Sg_fd *sfp, Sg_request *srp)
788{
789 unsigned long flags;
790 int ret;
791
792 read_lock_irqsave(&sfp->rq_list_lock, flags);
793 ret = srp->done;
794 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
795 return ret;
796}
797
1da177e4 798static int
f4927c45 799sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1da177e4
LT		 800{
801 void __user *p = (void __user *)arg;
802 int __user *ip = p;
803 int result, val, read_only;
804 Sg_device *sdp;
805 Sg_fd *sfp;
806 Sg_request *srp;
807 unsigned long iflags;
808
809 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
810 return -ENXIO;
abf54393 811
1da177e4
LT		 812 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
813 sdp->disk->disk_name, (int) cmd_in));
814 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
815
816 switch (cmd_in) {
817 case SG_IO:
dddbf8d9
JE		 818 if (sdp->detached)
819 return -ENODEV;
820 if (!scsi_block_when_processing_errors(sdp->device))
821 return -ENXIO;
822 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
823 return -EFAULT;
824 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
825 1, read_only, 1, &srp);
826 if (result < 0)
827 return result;
3f0c6aba 828 result = wait_event_interruptible(sfp->read_wait,
6acddc5e 829 (srp_done(sfp, srp) || sdp->detached));
794c10fa
JE		 830 if (sdp->detached)
831 return -ENODEV;
832 write_lock_irq(&sfp->rq_list_lock);
833 if (srp->done) {
834 srp->done = 2;
dddbf8d9 835 write_unlock_irq(&sfp->rq_list_lock);
794c10fa
JE		 836 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
837 return (result < 0) ? result : 0;
1da177e4 838 }
794c10fa
JE		 839 srp->orphan = 1;
840 write_unlock_irq(&sfp->rq_list_lock);
841 return result; /* -ERESTARTSYS because signal hit process */
1da177e4
LT		 842 case SG_SET_TIMEOUT:
843 result = get_user(val, ip);
844 if (result)
845 return result;
846 if (val < 0)
847 return -EIO;
848 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
849 val = MULDIV (INT_MAX, USER_HZ, HZ);
850 sfp->timeout_user = val;
851 sfp->timeout = MULDIV (val, HZ, USER_HZ);
852
853 return 0;
854 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
855 /* strange ..., for backward compatibility */
856 return sfp->timeout_user;
857 case SG_SET_FORCE_LOW_DMA:
858 result = get_user(val, ip);
859 if (result)
860 return result;
861 if (val) {
862 sfp->low_dma = 1;
863 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
864 val = (int) sfp->reserve.bufflen;
865 sg_remove_scat(&sfp->reserve);
866 sg_build_reserve(sfp, val);
867 }
868 } else {
869 if (sdp->detached)
870 return -ENODEV;
871 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
872 }
873 return 0;
874 case SG_GET_LOW_DMA:
875 return put_user((int) sfp->low_dma, ip);
876 case SG_GET_SCSI_ID:
877 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
878 return -EFAULT;
879 else {
880 sg_scsi_id_t __user *sg_idp = p;
881
882 if (sdp->detached)
883 return -ENODEV;
884 __put_user((int) sdp->device->host->host_no,
885 &sg_idp->host_no);
886 __put_user((int) sdp->device->channel,
887 &sg_idp->channel);
888 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
889 __put_user((int) sdp->device->lun, &sg_idp->lun);
890 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
891 __put_user((short) sdp->device->host->cmd_per_lun,
892 &sg_idp->h_cmd_per_lun);
893 __put_user((short) sdp->device->queue_depth,
894 &sg_idp->d_queue_depth);
895 __put_user(0, &sg_idp->unused[0]);
896 __put_user(0, &sg_idp->unused[1]);
897 return 0;
898 }
899 case SG_SET_FORCE_PACK_ID:
900 result = get_user(val, ip);
901 if (result)
902 return result;
903 sfp->force_packid = val ? 1 : 0;
904 return 0;
905 case SG_GET_PACK_ID:
906 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
907 return -EFAULT;
908 read_lock_irqsave(&sfp->rq_list_lock, iflags);
909 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
910 if ((1 == srp->done) && (!srp->sg_io_owned)) {
911 read_unlock_irqrestore(&sfp->rq_list_lock,
912 iflags);
913 __put_user(srp->header.pack_id, ip);
914 return 0;
915 }
916 }
917 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
918 __put_user(-1, ip);
919 return 0;
920 case SG_GET_NUM_WAITING:
921 read_lock_irqsave(&sfp->rq_list_lock, iflags);
922 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
923 if ((1 == srp->done) && (!srp->sg_io_owned))
924 ++val;
925 }
926 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
927 return put_user(val, ip);
928 case SG_GET_SG_TABLESIZE:
929 return put_user(sdp->sg_tablesize, ip);
930 case SG_SET_RESERVED_SIZE:
931 result = get_user(val, ip);
932 if (result)
933 return result;
934 if (val < 0)
935 return -EINVAL;
44ec9542 936 val = min_t(int, val,
ae03bf63 937 queue_max_sectors(sdp->device->request_queue) * 512);
1da177e4
LT		 938 if (val != sfp->reserve.bufflen) {
939 if (sg_res_in_use(sfp) || sfp->mmap_called)
940 return -EBUSY;
941 sg_remove_scat(&sfp->reserve);
942 sg_build_reserve(sfp, val);
943 }
944 return 0;
945 case SG_GET_RESERVED_SIZE:
44ec9542 946 val = min_t(int, sfp->reserve.bufflen,
ae03bf63 947 queue_max_sectors(sdp->device->request_queue) * 512);
1da177e4
LT		 948 return put_user(val, ip);
949 case SG_SET_COMMAND_Q:
950 result = get_user(val, ip);
951 if (result)
952 return result;
953 sfp->cmd_q = val ? 1 : 0;
954 return 0;
955 case SG_GET_COMMAND_Q:
956 return put_user((int) sfp->cmd_q, ip);
957 case SG_SET_KEEP_ORPHAN:
958 result = get_user(val, ip);
959 if (result)
960 return result;
961 sfp->keep_orphan = val;
962 return 0;
963 case SG_GET_KEEP_ORPHAN:
964 return put_user((int) sfp->keep_orphan, ip);
965 case SG_NEXT_CMD_LEN:
966 result = get_user(val, ip);
967 if (result)
968 return result;
969 sfp->next_cmd_len = (val > 0) ? val : 0;
970 return 0;
971 case SG_GET_VERSION_NUM:
972 return put_user(sg_version_num, ip);
973 case SG_GET_ACCESS_COUNT:
974 /* faked - we don't have a real access count anymore */
975 val = (sdp->device ? 1 : 0);
976 return put_user(val, ip);
977 case SG_GET_REQUEST_TABLE:
978 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
979 return -EFAULT;
980 else {
cb59e840 981 sg_req_info_t *rinfo;
982 unsigned int ms;
983
984 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
985 GFP_KERNEL);
986 if (!rinfo)
987 return -ENOMEM;
1da177e4
LT		 988 read_lock_irqsave(&sfp->rq_list_lock, iflags);
989 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
990 ++val, srp = srp ? srp->nextrp : srp) {
991 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
992 if (srp) {
993 rinfo[val].req_state = srp->done + 1;
994 rinfo[val].problem =
995 srp->header.masked_status &
996 srp->header.host_status &
997 srp->header.driver_status;
cb59e840 998 if (srp->done)
999 rinfo[val].duration =
1000 srp->header.duration;
1001 else {
1002 ms = jiffies_to_msecs(jiffies);
1003 rinfo[val].duration =
1004 (ms > srp->header.duration) ?
1005 (ms - srp->header.duration) : 0;
1006 }
1da177e4 1007 rinfo[val].orphan = srp->orphan;
cb59e840 1008 rinfo[val].sg_io_owned =
1009 srp->sg_io_owned;
1010 rinfo[val].pack_id =
1011 srp->header.pack_id;
1012 rinfo[val].usr_ptr =
1013 srp->header.usr_ptr;
1da177e4
LT		 1014 }
1015 }
1016 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
cb59e840 1017 result = __copy_to_user(p, rinfo,
1018 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1019 result = result ? -EFAULT : 0;
1020 kfree(rinfo);
1021 return result;
1da177e4
LT		 1022 }
1023 case SG_EMULATED_HOST:
1024 if (sdp->detached)
1025 return -ENODEV;
1026 return put_user(sdp->device->host->hostt->emulated, ip);
1027 case SG_SCSI_RESET:
1028 if (sdp->detached)
1029 return -ENODEV;
1030 if (filp->f_flags & O_NONBLOCK) {
939647ee 1031 if (scsi_host_in_recovery(sdp->device->host))
1da177e4
LT		 1032 return -EBUSY;
1033 } else if (!scsi_block_when_processing_errors(sdp->device))
1034 return -EBUSY;
1035 result = get_user(val, ip);
1036 if (result)
1037 return result;
1038 if (SG_SCSI_RESET_NOTHING == val)
1039 return 0;
1040 switch (val) {
1041 case SG_SCSI_RESET_DEVICE:
1042 val = SCSI_TRY_RESET_DEVICE;
1043 break;
39120e11
BK		 1044 case SG_SCSI_RESET_TARGET:
1045 val = SCSI_TRY_RESET_TARGET;
1046 break;
1da177e4
LT		 1047 case SG_SCSI_RESET_BUS:
1048 val = SCSI_TRY_RESET_BUS;
1049 break;
1050 case SG_SCSI_RESET_HOST:
1051 val = SCSI_TRY_RESET_HOST;
1052 break;
1053 default:
1054 return -EINVAL;
1055 }
1056 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1057 return -EACCES;
1058 return (scsi_reset_provider(sdp->device, val) ==
1059 SUCCESS) ? 0 : -EIO;
1060 case SCSI_IOCTL_SEND_COMMAND:
1061 if (sdp->detached)
1062 return -ENODEV;
1063 if (read_only) {
1064 unsigned char opcode = WRITE_6;
1065 Scsi_Ioctl_Command __user *siocp = p;
1066
1067 if (copy_from_user(&opcode, siocp->data, 1))
1068 return -EFAULT;
14e507b8 1069 if (sg_allow_access(filp, &opcode))
1da177e4
LT		 1070 return -EPERM;
1071 }
e915e872 1072 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1da177e4
LT		 1073 case SG_SET_DEBUG:
1074 result = get_user(val, ip);
1075 if (result)
1076 return result;
1077 sdp->sgdebug = (char) val;
1078 return 0;
1079 case SCSI_IOCTL_GET_IDLUN:
1080 case SCSI_IOCTL_GET_BUS_NUMBER:
1081 case SCSI_IOCTL_PROBE_HOST:
1082 case SG_GET_TRANSFORM:
1083 if (sdp->detached)
1084 return -ENODEV;
1085 return scsi_ioctl(sdp->device, cmd_in, p);
44ec9542 1086 case BLKSECTGET:
ae03bf63 1087 return put_user(queue_max_sectors(sdp->device->request_queue) * 512,
44ec9542 1088 ip);
6da127ad
CS		 1089 case BLKTRACESETUP:
1090 return blk_trace_setup(sdp->device->request_queue,
1091 sdp->disk->disk_name,
76e3a19d 1092 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
d0deef5b 1093 NULL,
6da127ad
CS		 1094 (char *)arg);
1095 case BLKTRACESTART:
1096 return blk_trace_startstop(sdp->device->request_queue, 1);
1097 case BLKTRACESTOP:
1098 return blk_trace_startstop(sdp->device->request_queue, 0);
1099 case BLKTRACETEARDOWN:
1100 return blk_trace_remove(sdp->device->request_queue);
1da177e4
LT		 1101 default:
1102 if (read_only)
1103 return -EPERM; /* don't know so take safe approach */
1104 return scsi_ioctl(sdp->device, cmd_in, p);
1105 }
1106}
1107
f4927c45
AB		 1108static long
1109sg_unlocked_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1110{
1111 int ret;
1112
c45d15d2 1113 mutex_lock(&sg_mutex);
f4927c45 1114 ret = sg_ioctl(filp, cmd_in, arg);
c45d15d2 1115 mutex_unlock(&sg_mutex);
f4927c45
AB		 1116
1117 return ret;
1118}
1119
1da177e4
LT		 1120#ifdef CONFIG_COMPAT
1121static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1122{
1123 Sg_device *sdp;
1124 Sg_fd *sfp;
1125 struct scsi_device *sdev;
1126
1127 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1128 return -ENXIO;
1129
1130 sdev = sdp->device;
1131 if (sdev->host->hostt->compat_ioctl) {
1132 int ret;
1133
1134 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1135
1136 return ret;
1137 }
1138
1139 return -ENOIOCTLCMD;
1140}
1141#endif
1142
1143static unsigned int
1144sg_poll(struct file *filp, poll_table * wait)
1145{
1146 unsigned int res = 0;
1147 Sg_device *sdp;
1148 Sg_fd *sfp;
1149 Sg_request *srp;
1150 int count = 0;
1151 unsigned long iflags;
1152
ebaf466b
JE		 1153 sfp = filp->private_data;
1154 if (!sfp)
1155 return POLLERR;
1156 sdp = sfp->parentdp;
1157 if (!sdp)
1da177e4
LT		 1158 return POLLERR;
1159 poll_wait(filp, &sfp->read_wait, wait);
1160 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1161 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1162 /* if any read waiting, flag it */
1163 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1164 res = POLLIN | POLLRDNORM;
1165 ++count;
1166 }
1167 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1168
1169 if (sdp->detached)
1170 res |= POLLHUP;
1171 else if (!sfp->cmd_q) {
1172 if (0 == count)
1173 res |= POLLOUT | POLLWRNORM;
1174 } else if (count < SG_MAX_QUEUE)
1175 res |= POLLOUT | POLLWRNORM;
1176 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1177 sdp->disk->disk_name, (int) res));
1178 return res;
1179}
1180
1181static int
1182sg_fasync(int fd, struct file *filp, int mode)
1183{
1da177e4
LT		 1184 Sg_device *sdp;
1185 Sg_fd *sfp;
1186
1187 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1188 return -ENXIO;
1189 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1190 sdp->disk->disk_name, mode));
1191
60aa4924 1192 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1da177e4
LT		 1193}
1194
a13ff0bb
NP		 1195static int
1196sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1da177e4
LT		 1197{
1198 Sg_fd *sfp;
d6b10348 1199 unsigned long offset, len, sa;
1da177e4 1200 Sg_scatter_hold *rsv_schp;
10db10d1 1201 int k, length;
1da177e4
LT		 1202
1203 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
a13ff0bb 1204 return VM_FAULT_SIGBUS;
1da177e4 1205 rsv_schp = &sfp->reserve;
a13ff0bb 1206 offset = vmf->pgoff << PAGE_SHIFT;
1da177e4 1207 if (offset >= rsv_schp->bufflen)
a13ff0bb
NP		 1208 return VM_FAULT_SIGBUS;
1209 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1da177e4 1210 offset, rsv_schp->k_use_sg));
d6b10348 1211 sa = vma->vm_start;
10db10d1
FT		 1212 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1213 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
d6b10348 1214 len = vma->vm_end - sa;
10db10d1 1215 len = (len < length) ? len : length;
d6b10348 1216 if (offset < len) {
10db10d1
FT		 1217 struct page *page = nth_page(rsv_schp->pages[k],
1218 offset >> PAGE_SHIFT);
d6b10348 1219 get_page(page); /* increment page count */
a13ff0bb
NP		 1220 vmf->page = page;
1221 return 0; /* success */
1da177e4 1222 }
d6b10348
MC		 1223 sa += len;
1224 offset -= len;
1da177e4 1225 }
d6b10348 1226
a13ff0bb 1227 return VM_FAULT_SIGBUS;
1da177e4
LT		 1228}
1229
f0f37e2f 1230static const struct vm_operations_struct sg_mmap_vm_ops = {
a13ff0bb 1231 .fault = sg_vma_fault,
1da177e4
LT		 1232};
1233
1234static int
1235sg_mmap(struct file *filp, struct vm_area_struct *vma)
1236{
1237 Sg_fd *sfp;
d6b10348 1238 unsigned long req_sz, len, sa;
1da177e4 1239 Sg_scatter_hold *rsv_schp;
10db10d1 1240 int k, length;
1da177e4
LT		 1241
1242 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1243 return -ENXIO;
cb59e840 1244 req_sz = vma->vm_end - vma->vm_start;
1da177e4
LT		 1245 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1246 (void *) vma->vm_start, (int) req_sz));
1247 if (vma->vm_pgoff)
1248 return -EINVAL; /* want no offset */
1249 rsv_schp = &sfp->reserve;
1250 if (req_sz > rsv_schp->bufflen)
1251 return -ENOMEM; /* cannot map more than reserved buffer */
1252
d6b10348 1253 sa = vma->vm_start;
10db10d1
FT		 1254 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1255 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
d6b10348 1256 len = vma->vm_end - sa;
10db10d1 1257 len = (len < length) ? len : length;
d6b10348 1258 sa += len;
1da177e4 1259 }
d6b10348 1260
f9aed0e2 1261 sfp->mmap_called = 1;
1c8e71d7 1262 vma->vm_flags |= VM_RESERVED;
1da177e4
LT		 1263 vma->vm_private_data = sfp;
1264 vma->vm_ops = &sg_mmap_vm_ops;
1265 return 0;
1266}
1267
c96952ed
FT		 1268static void sg_rq_end_io_usercontext(struct work_struct *work)
1269{
1270 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1271 struct sg_fd *sfp = srp->parentfp;
1272
1273 sg_finish_rem_req(srp);
1274 kref_put(&sfp->f_ref, sg_remove_sfp);
1275}
1276
a91a3a20
FT		 1277/*
1278 * This function is a "bottom half" handler that is called by the mid
1279 * level when a command is completed (or has failed).
1280 */
1281static void sg_rq_end_io(struct request *rq, int uptodate)
1da177e4 1282{
a91a3a20 1283 struct sg_request *srp = rq->end_io_data;
c6517b79 1284 Sg_device *sdp;
1da177e4 1285 Sg_fd *sfp;
1da177e4 1286 unsigned long iflags;
cb59e840 1287 unsigned int ms;
a91a3a20 1288 char *sense;
c6517b79 1289 int result, resid, done = 1;
1da177e4 1290
c6517b79 1291 if (WARN_ON(srp->done != 0))
1da177e4 1292 return;
c6517b79 1293
1da177e4 1294 sfp = srp->parentfp;
c6517b79 1295 if (WARN_ON(sfp == NULL))
1da177e4 1296 return;
c6517b79
TB		 1297
1298 sdp = sfp->parentdp;
1299 if (unlikely(sdp->detached))
1300 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1da177e4 1301
a91a3a20
FT		 1302 sense = rq->sense;
1303 result = rq->errors;
c3a4d78c 1304 resid = rq->resid_len;
1da177e4
LT		 1305
1306 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
d6b10348
MC		 1307 sdp->disk->disk_name, srp->header.pack_id, result));
1308 srp->header.resid = resid;
cb59e840 1309 ms = jiffies_to_msecs(jiffies);
1310 srp->header.duration = (ms > srp->header.duration) ?
1311 (ms - srp->header.duration) : 0;
d6b10348 1312 if (0 != result) {
1da177e4
LT		 1313 struct scsi_sense_hdr sshdr;
1314
d6b10348
MC		 1315 srp->header.status = 0xff & result;
1316 srp->header.masked_status = status_byte(result);
1317 srp->header.msg_status = msg_byte(result);
1318 srp->header.host_status = host_byte(result);
1319 srp->header.driver_status = driver_byte(result);
1da177e4
LT		 1320 if ((sdp->sgdebug > 0) &&
1321 ((CHECK_CONDITION == srp->header.masked_status) ||
1322 (COMMAND_TERMINATED == srp->header.masked_status)))
d6b10348
MC		 1323 __scsi_print_sense("sg_cmd_done", sense,
1324 SCSI_SENSE_BUFFERSIZE);
1da177e4
LT		 1325
1326 /* Following if statement is a patch supplied by Eric Youngdale */
d6b10348
MC		 1327 if (driver_byte(result) != 0
1328 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1da177e4
LT		 1329 && !scsi_sense_is_deferred(&sshdr)
1330 && sshdr.sense_key == UNIT_ATTENTION
1331 && sdp->device->removable) {
1332 /* Detected possible disc change. Set the bit - this */
1333 /* may be used if there are filesystems using this device */
1334 sdp->device->changed = 1;
1335 }
1336 }
1337 /* Rely on write phase to clean out srp status values, so no "else" */
1338
c6517b79
TB		 1339 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1340 if (unlikely(srp->orphan)) {
1da177e4
LT		 1341 if (sfp->keep_orphan)
1342 srp->sg_io_owned = 0;
c6517b79
TB		 1343 else
1344 done = 0;
1da177e4 1345 }
c6517b79
TB		 1346 srp->done = done;
1347 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1348
1349 if (likely(done)) {
1350 /* Now wake up any sg_read() that is waiting for this
1351 * packet.
1352 */
1da177e4 1353 wake_up_interruptible(&sfp->read_wait);
c6517b79 1354 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
c96952ed 1355 kref_put(&sfp->f_ref, sg_remove_sfp);
015640ed
FT		 1356 } else {
1357 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1358 schedule_work(&srp->ew.work);
1359 }
1da177e4
LT		 1360}
1361
828c0950 1362static const struct file_operations sg_fops = {
1da177e4
LT		 1363 .owner = THIS_MODULE,
1364 .read = sg_read,
1365 .write = sg_write,
1366 .poll = sg_poll,
f4927c45 1367 .unlocked_ioctl = sg_unlocked_ioctl,
1da177e4
LT		 1368#ifdef CONFIG_COMPAT
1369 .compat_ioctl = sg_compat_ioctl,
1370#endif
1371 .open = sg_open,
1372 .mmap = sg_mmap,
1373 .release = sg_release,
1374 .fasync = sg_fasync,
6038f373 1375 .llseek = no_llseek,
1da177e4
LT		 1376};
1377
d253878b 1378static struct class *sg_sysfs_class;
1da177e4
LT		 1379
1380static int sg_sysfs_valid = 0;
1381
7c07d613 1382static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1da177e4 1383{
d6b10348 1384 struct request_queue *q = scsidp->request_queue;
1da177e4
LT		 1385 Sg_device *sdp;
1386 unsigned long iflags;
7c07d613
JB		 1387 int error;
1388 u32 k;
1da177e4 1389
24669f75 1390 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1da177e4
LT		 1391 if (!sdp) {
1392 printk(KERN_WARNING "kmalloc Sg_device failure\n");
7c07d613
JB		 1393 return ERR_PTR(-ENOMEM);
1394 }
c6517b79 1395
7c07d613
JB		 1396 if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
1397 printk(KERN_WARNING "idr expansion Sg_device failure\n");
c6517b79 1398 error = -ENOMEM;
7c07d613 1399 goto out;
1da177e4
LT		 1400 }
1401
7c07d613 1402 write_lock_irqsave(&sg_index_lock, iflags);
1da177e4 1403
c6517b79 1404 error = idr_get_new(&sg_index_idr, sdp, &k);
7c07d613 1405 if (error) {
c6517b79 1406 write_unlock_irqrestore(&sg_index_lock, iflags);
7c07d613
JB		 1407 printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
1408 error);
1409 goto out;
1da177e4
LT		 1410 }
1411
1da177e4
LT		 1412 if (unlikely(k >= SG_MAX_DEVS))
1413 goto overflow;
1414
1da177e4
LT		 1415 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1416 sprintf(disk->disk_name, "sg%d", k);
1417 disk->first_minor = k;
1418 sdp->disk = disk;
1419 sdp->device = scsidp;
3442f802 1420 INIT_LIST_HEAD(&sdp->sfds);
1da177e4 1421 init_waitqueue_head(&sdp->o_excl_wait);
8a78362c 1422 sdp->sg_tablesize = queue_max_segments(q);
7c07d613 1423 sdp->index = k;
c6517b79
TB		 1424 kref_init(&sdp->d_ref);
1425
1426 write_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4 1427
7c07d613 1428 error = 0;
1da177e4 1429 out:
7c07d613 1430 if (error) {
1da177e4 1431 kfree(sdp);
7c07d613
JB		 1432 return ERR_PTR(error);
1433 }
1434 return sdp;
1da177e4
LT		 1435
1436 overflow:
c6517b79
TB		 1437 idr_remove(&sg_index_idr, k);
1438 write_unlock_irqrestore(&sg_index_lock, iflags);
9ccfc756
JB		 1439 sdev_printk(KERN_WARNING, scsidp,
1440 "Unable to attach sg device type=%d, minor "
1441 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1da177e4
LT		 1442 error = -ENODEV;
1443 goto out;
1444}
1445
1446static int
ee959b00 1447sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1da177e4 1448{
ee959b00 1449 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1da177e4
LT		 1450 struct gendisk *disk;
1451 Sg_device *sdp = NULL;
1452 struct cdev * cdev = NULL;
7c07d613 1453 int error;
454e8957 1454 unsigned long iflags;
1da177e4
LT		 1455
1456 disk = alloc_disk(1);
1457 if (!disk) {
1458 printk(KERN_WARNING "alloc_disk failed\n");
1459 return -ENOMEM;
1460 }
1461 disk->major = SCSI_GENERIC_MAJOR;
1462
1463 error = -ENOMEM;
1464 cdev = cdev_alloc();
1465 if (!cdev) {
1466 printk(KERN_WARNING "cdev_alloc failed\n");
1467 goto out;
1468 }
1469 cdev->owner = THIS_MODULE;
1470 cdev->ops = &sg_fops;
1471
7c07d613
JB		 1472 sdp = sg_alloc(disk, scsidp);
1473 if (IS_ERR(sdp)) {
1da177e4 1474 printk(KERN_WARNING "sg_alloc failed\n");
7c07d613 1475 error = PTR_ERR(sdp);
1da177e4
LT		 1476 goto out;
1477 }
1da177e4 1478
7c07d613 1479 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
5e3c34c1 1480 if (error)
454e8957 1481 goto cdev_add_err;
5e3c34c1 1482
1da177e4
LT		 1483 sdp->cdev = cdev;
1484 if (sg_sysfs_valid) {
ee959b00 1485 struct device *sg_class_member;
1da177e4 1486
d73a1a67
GKH		 1487 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1488 MKDEV(SCSI_GENERIC_MAJOR,
1489 sdp->index),
1490 sdp, "%s", disk->disk_name);
d07e0361
FT		 1491 if (IS_ERR(sg_class_member)) {
1492 printk(KERN_ERR "sg_add: "
ee959b00 1493 "device_create failed\n");
d07e0361
FT		 1494 error = PTR_ERR(sg_class_member);
1495 goto cdev_add_err;
1496 }
d07e0361 1497 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1da177e4
LT		 1498 &sg_class_member->kobj, "generic");
1499 if (error)
1500 printk(KERN_ERR "sg_add: unable to make symlink "
7c07d613 1501 "'generic' back to sg%d\n", sdp->index);
1da177e4 1502 } else
7c07d613 1503 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1da177e4 1504
9ccfc756 1505 sdev_printk(KERN_NOTICE, scsidp,
7c07d613
JB		 1506 "Attached scsi generic sg%d type %d\n", sdp->index,
1507 scsidp->type);
1da177e4 1508
ee959b00 1509 dev_set_drvdata(cl_dev, sdp);
a24484f2 1510
1da177e4
LT		 1511 return 0;
1512
454e8957 1513cdev_add_err:
7c07d613
JB		 1514 write_lock_irqsave(&sg_index_lock, iflags);
1515 idr_remove(&sg_index_idr, sdp->index);
1516 write_unlock_irqrestore(&sg_index_lock, iflags);
1517 kfree(sdp);
454e8957 1518
1da177e4
LT		 1519out:
1520 put_disk(disk);
1521 if (cdev)
1522 cdev_del(cdev);
1523 return error;
1524}
1525
c6517b79
TB		 1526static void sg_device_destroy(struct kref *kref)
1527{
1528 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1529 unsigned long flags;
1530
1531 /* CAUTION! Note that the device can still be found via idr_find()
1532 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1533 * any other cleanup.
1534 */
1535
1536 write_lock_irqsave(&sg_index_lock, flags);
1537 idr_remove(&sg_index_idr, sdp->index);
1538 write_unlock_irqrestore(&sg_index_lock, flags);
1539
1540 SCSI_LOG_TIMEOUT(3,
1541 printk("sg_device_destroy: %s\n",
1542 sdp->disk->disk_name));
1543
1544 put_disk(sdp->disk);
1545 kfree(sdp);
1546}
1547
1548static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1da177e4 1549{
ee959b00
TJ		 1550 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1551 Sg_device *sdp = dev_get_drvdata(cl_dev);
1da177e4
LT		 1552 unsigned long iflags;
1553 Sg_fd *sfp;
1da177e4 1554
c6517b79 1555 if (!sdp || sdp->detached)
1da177e4 1556 return;
7c07d613 1557
c6517b79
TB		 1558 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1559
1560 /* Need a write lock to set sdp->detached. */
7c07d613 1561 write_lock_irqsave(&sg_index_lock, iflags);
c6517b79 1562 sdp->detached = 1;
3442f802 1563 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
c6517b79
TB		 1564 wake_up_interruptible(&sfp->read_wait);
1565 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
7c07d613
JB		 1566 }
1567 write_unlock_irqrestore(&sg_index_lock, iflags);
1568
1569 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
ee959b00 1570 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
7c07d613
JB		 1571 cdev_del(sdp->cdev);
1572 sdp->cdev = NULL;
1da177e4 1573
c6517b79 1574 sg_put_dev(sdp);
1da177e4
LT		 1575}
1576
6460e75a
DG		 1577module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1578module_param_named(def_reserved_size, def_reserved_size, int,
1579 S_IRUGO | S_IWUSR);
1da177e4
LT		 1580module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1581
1582MODULE_AUTHOR("Douglas Gilbert");
1583MODULE_DESCRIPTION("SCSI generic (sg) driver");
1584MODULE_LICENSE("GPL");
1585MODULE_VERSION(SG_VERSION_STR);
f018fa55 1586MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1da177e4 1587
6460e75a
DG		 1588MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1589 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1da177e4
LT		 1590MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1591MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1592
1593static int __init
1594init_sg(void)
1595{
1596 int rc;
1597
6460e75a
DG		 1598 if (scatter_elem_sz < PAGE_SIZE) {
1599 scatter_elem_sz = PAGE_SIZE;
1600 scatter_elem_sz_prev = scatter_elem_sz;
1601 }
1da177e4
LT		 1602 if (def_reserved_size >= 0)
1603 sg_big_buff = def_reserved_size;
6460e75a
DG		 1604 else
1605 def_reserved_size = sg_big_buff;
1da177e4
LT		 1606
1607 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1608 SG_MAX_DEVS, "sg");
1609 if (rc)
1610 return rc;
d253878b 1611 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1da177e4
LT		 1612 if ( IS_ERR(sg_sysfs_class) ) {
1613 rc = PTR_ERR(sg_sysfs_class);
1614 goto err_out;
1615 }
1616 sg_sysfs_valid = 1;
1617 rc = scsi_register_interface(&sg_interface);
1618 if (0 == rc) {
1619#ifdef CONFIG_SCSI_PROC_FS
1620 sg_proc_init();
1621#endif /* CONFIG_SCSI_PROC_FS */
1622 return 0;
1623 }
d253878b 1624 class_destroy(sg_sysfs_class);
1da177e4
LT		 1625err_out:
1626 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1627 return rc;
1628}
1629
1630static void __exit
1631exit_sg(void)
1632{
1633#ifdef CONFIG_SCSI_PROC_FS
1634 sg_proc_cleanup();
1635#endif /* CONFIG_SCSI_PROC_FS */
1636 scsi_unregister_interface(&sg_interface);
d253878b 1637 class_destroy(sg_sysfs_class);
1da177e4
LT		 1638 sg_sysfs_valid = 0;
1639 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1640 SG_MAX_DEVS);
7c07d613 1641 idr_destroy(&sg_index_idr);
1da177e4
LT		 1642}
1643
44c7b0ea 1644static int sg_start_req(Sg_request *srp, unsigned char *cmd)
10865dfa 1645{
626710c9 1646 int res;
10865dfa 1647 struct request *rq;
44c7b0ea
FT		 1648 Sg_fd *sfp = srp->parentfp;
1649 sg_io_hdr_t *hp = &srp->header;
1650 int dxfer_len = (int) hp->dxfer_len;
1651 int dxfer_dir = hp->dxfer_direction;
626710c9 1652 unsigned int iov_count = hp->iovec_count;
44c7b0ea
FT		 1653 Sg_scatter_hold *req_schp = &srp->data;
1654 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1655 struct request_queue *q = sfp->parentdp->device->request_queue;
626710c9 1656 struct rq_map_data *md, map_data;
10865dfa
FT		 1657 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1658
44c7b0ea
FT		 1659 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1660 dxfer_len));
1661
10865dfa
FT		 1662 rq = blk_get_request(q, rw, GFP_ATOMIC);
1663 if (!rq)
1664 return -ENOMEM;
1665
1666 memcpy(rq->cmd, cmd, hp->cmd_len);
1667
1668 rq->cmd_len = hp->cmd_len;
1669 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1670
1671 srp->rq = rq;
1672 rq->end_io_data = srp;
1673 rq->sense = srp->sense_b;
1674 rq->retries = SG_DEFAULT_RETRIES;
1675
1da177e4 1676 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
10db10d1 1677 return 0;
10865dfa 1678
626710c9
FT		 1679 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1680 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1681 !sfp->parentdp->device->host->unchecked_isa_dma &&
2610a254 1682 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
626710c9
FT		 1683 md = NULL;
1684 else
1685 md = &map_data;
1686
1687 if (md) {
1688 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1689 sg_link_reserve(sfp, srp, dxfer_len);
1690 else {
1691 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1692 if (res)
1693 return res;
1694 }
7e56cb0f 1695
626710c9
FT		 1696 md->pages = req_schp->pages;
1697 md->page_order = req_schp->page_order;
1698 md->nr_entries = req_schp->k_use_sg;
56c451f4 1699 md->offset = 0;
97ae77a1 1700 md->null_mapped = hp->dxferp ? 0 : 1;
ecb554a8
FT		 1701 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1702 md->from_user = 1;
1703 else
1704 md->from_user = 0;
626710c9
FT		 1705 }
1706
0fdf96b6
FT		 1707 if (iov_count) {
1708 int len, size = sizeof(struct sg_iovec) * iov_count;
1709 struct iovec *iov;
1710
3094141c
JL		 1711 iov = memdup_user(hp->dxferp, size);
1712 if (IS_ERR(iov))
1713 return PTR_ERR(iov);
0fdf96b6
FT		 1714
1715 len = iov_length(iov, iov_count);
1716 if (hp->dxfer_len < len) {
1717 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1718 len = hp->dxfer_len;
1719 }
1720
1721 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1722 iov_count,
1723 len, GFP_ATOMIC);
1724 kfree(iov);
1725 } else
626710c9
FT		 1726 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1727 hp->dxfer_len, GFP_ATOMIC);
10db10d1
FT		 1728
1729 if (!res) {
626710c9 1730 srp->bio = rq->bio;
10db10d1 1731
626710c9
FT		 1732 if (!md) {
1733 req_schp->dio_in_use = 1;
1734 hp->info |= SG_INFO_DIRECT_IO;
1735 }
1736 }
10db10d1 1737 return res;
1da177e4
LT		 1738}
1739
e7ee4cc0 1740static int sg_finish_rem_req(Sg_request * srp)
1da177e4 1741{
e7ee4cc0
FT		 1742 int ret = 0;
1743
1da177e4
LT		 1744 Sg_fd *sfp = srp->parentfp;
1745 Sg_scatter_hold *req_schp = &srp->data;
1746
1747 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
6e5a30cb
FT		 1748 if (srp->rq) {
1749 if (srp->bio)
e7ee4cc0 1750 ret = blk_rq_unmap_user(srp->bio);
10db10d1 1751
10865dfa 1752 blk_put_request(srp->rq);
6e5a30cb 1753 }
10865dfa 1754
e27168f8
CS		 1755 if (srp->res_used)
1756 sg_unlink_reserve(sfp, srp);
1757 else
1758 sg_remove_scat(req_schp);
1759
1da177e4 1760 sg_remove_request(sfp, srp);
e7ee4cc0
FT		 1761
1762 return ret;
1da177e4
LT		 1763}
1764
1765static int
1766sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1767{
10db10d1 1768 int sg_bufflen = tablesize * sizeof(struct page *);
2d20eaf9 1769 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1da177e4 1770
10db10d1
FT		 1771 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1772 if (!schp->pages)
1da177e4 1773 return -ENOMEM;
1da177e4 1774 schp->sglist_len = sg_bufflen;
d6b10348 1775 return tablesize; /* number of scat_gath elements allocated */
1da177e4
LT		 1776}
1777
1da177e4
LT		 1778static int
1779sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1780{
10db10d1 1781 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
d6b10348 1782 int sg_tablesize = sfp->parentdp->sg_tablesize;
10db10d1
FT		 1783 int blk_size = buff_size, order;
1784 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1da177e4 1785
fb119935 1786 if (blk_size < 0)
1da177e4
LT		 1787 return -EFAULT;
1788 if (0 == blk_size)
1789 ++blk_size; /* don't know why */
b2ed6c69
FT		 1790 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1791 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1da177e4
LT		 1792 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1793 buff_size, blk_size));
d6b10348
MC		 1794
1795 /* N.B. ret_sz carried into this block ... */
1796 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1797 if (mx_sc_elems < 0)
1798 return mx_sc_elems; /* most likely -ENOMEM */
1799
6460e75a
DG		 1800 num = scatter_elem_sz;
1801 if (unlikely(num != scatter_elem_sz_prev)) {
1802 if (num < PAGE_SIZE) {
1803 scatter_elem_sz = PAGE_SIZE;
1804 scatter_elem_sz_prev = PAGE_SIZE;
1805 } else
1806 scatter_elem_sz_prev = num;
1807 }
10db10d1
FT		 1808
1809 if (sfp->low_dma)
1810 gfp_mask |= GFP_DMA;
1811
1812 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1813 gfp_mask |= __GFP_ZERO;
1814
1815 order = get_order(num);
1816retry:
1817 ret_sz = 1 << (PAGE_SHIFT + order);
1818
1819 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1820 k++, rem_sz -= ret_sz) {
1821
6460e75a 1822 num = (rem_sz > scatter_elem_sz_prev) ?
10db10d1
FT		 1823 scatter_elem_sz_prev : rem_sz;
1824
1825 schp->pages[k] = alloc_pages(gfp_mask, order);
1826 if (!schp->pages[k])
1827 goto out;
d6b10348 1828
6460e75a
DG		 1829 if (num == scatter_elem_sz_prev) {
1830 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1831 scatter_elem_sz = ret_sz;
1832 scatter_elem_sz_prev = ret_sz;
1833 }
1834 }
d6b10348 1835
7ca63cb4
DG		 1836 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1837 "ret_sz=%d\n", k, num, ret_sz));
d6b10348
MC		 1838 } /* end of for loop */
1839
10db10d1 1840 schp->page_order = order;
d6b10348 1841 schp->k_use_sg = k;
7ca63cb4
DG		 1842 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1843 "rem_sz=%d\n", k, rem_sz));
d6b10348
MC		 1844
1845 schp->bufflen = blk_size;
1846 if (rem_sz > 0) /* must have failed */
1847 return -ENOMEM;
1da177e4 1848 return 0;
10db10d1
FT		 1849out:
1850 for (i = 0; i < k; i++)
e71044ee 1851 __free_pages(schp->pages[i], order);
10db10d1
FT		 1852
1853 if (--order >= 0)
1854 goto retry;
1855
1856 return -ENOMEM;
1da177e4
LT		 1857}
1858
1da177e4
LT		 1859static void
1860sg_remove_scat(Sg_scatter_hold * schp)
1861{
1862 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
10db10d1 1863 if (schp->pages && schp->sglist_len > 0) {
6e5a30cb 1864 if (!schp->dio_in_use) {
1da177e4
LT		 1865 int k;
1866
10db10d1 1867 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1da177e4 1868 SCSI_LOG_TIMEOUT(5, printk(
10db10d1
FT		 1869 "sg_remove_scat: k=%d, pg=0x%p\n",
1870 k, schp->pages[k]));
1871 __free_pages(schp->pages[k], schp->page_order);
1da177e4 1872 }
6e5a30cb 1873
10db10d1 1874 kfree(schp->pages);
1da177e4 1875 }
d6b10348 1876 }
1da177e4
LT		 1877 memset(schp, 0, sizeof (*schp));
1878}
1879
1da177e4
LT		 1880static int
1881sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1882{
1883 Sg_scatter_hold *schp = &srp->data;
d6b10348 1884 int k, num;
1da177e4
LT		 1885
1886 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1887 num_read_xfer));
1888 if ((!outp) || (num_read_xfer <= 0))
1889 return 0;
d6b10348 1890
10db10d1
FT		 1891 num = 1 << (PAGE_SHIFT + schp->page_order);
1892 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
d6b10348 1893 if (num > num_read_xfer) {
10db10d1 1894 if (__copy_to_user(outp, page_address(schp->pages[k]),
d6b10348
MC		 1895 num_read_xfer))
1896 return -EFAULT;
1897 break;
1898 } else {
10db10d1 1899 if (__copy_to_user(outp, page_address(schp->pages[k]),
d6b10348
MC		 1900 num))
1901 return -EFAULT;
1902 num_read_xfer -= num;
1903 if (num_read_xfer <= 0)
1da177e4 1904 break;
d6b10348 1905 outp += num;
1da177e4 1906 }
1da177e4 1907 }
d6b10348 1908
1da177e4
LT		 1909 return 0;
1910}
1911
1912static void
1913sg_build_reserve(Sg_fd * sfp, int req_size)
1914{
1915 Sg_scatter_hold *schp = &sfp->reserve;
1916
1917 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1918 do {
1919 if (req_size < PAGE_SIZE)
1920 req_size = PAGE_SIZE;
1921 if (0 == sg_build_indirect(schp, sfp, req_size))
1922 return;
1923 else
1924 sg_remove_scat(schp);
1925 req_size >>= 1; /* divide by 2 */
1926 } while (req_size > (PAGE_SIZE / 2));
1927}
1928
1929static void
1930sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1931{
1932 Sg_scatter_hold *req_schp = &srp->data;
1933 Sg_scatter_hold *rsv_schp = &sfp->reserve;
d6b10348 1934 int k, num, rem;
1da177e4
LT		 1935
1936 srp->res_used = 1;
1937 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
eca7be5e 1938 rem = size;
d6b10348 1939
10db10d1
FT		 1940 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1941 for (k = 0; k < rsv_schp->k_use_sg; k++) {
d6b10348 1942 if (rem <= num) {
d6b10348
MC		 1943 req_schp->k_use_sg = k + 1;
1944 req_schp->sglist_len = rsv_schp->sglist_len;
10db10d1 1945 req_schp->pages = rsv_schp->pages;
d6b10348
MC		 1946
1947 req_schp->bufflen = size;
10db10d1 1948 req_schp->page_order = rsv_schp->page_order;
d6b10348
MC		 1949 break;
1950 } else
1951 rem -= num;
1da177e4 1952 }
d6b10348
MC		 1953
1954 if (k >= rsv_schp->k_use_sg)
1955 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1da177e4
LT		 1956}
1957
1958static void
1959sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1960{
1961 Sg_scatter_hold *req_schp = &srp->data;
1da177e4
LT		 1962
1963 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1964 (int) req_schp->k_use_sg));
1da177e4
LT		 1965 req_schp->k_use_sg = 0;
1966 req_schp->bufflen = 0;
10db10d1
FT		 1967 req_schp->pages = NULL;
1968 req_schp->page_order = 0;
1da177e4
LT		 1969 req_schp->sglist_len = 0;
1970 sfp->save_scat_len = 0;
1971 srp->res_used = 0;
1972}
1973
1974static Sg_request *
1975sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1976{
1977 Sg_request *resp;
1978 unsigned long iflags;
1979
1980 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1981 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1982 /* look for requests that are ready + not SG_IO owned */
1983 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1984 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1985 resp->done = 2; /* guard against other readers */
1986 break;
1987 }
1988 }
1989 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1990 return resp;
1991}
1992
1da177e4
LT		 1993/* always adds to end of list */
1994static Sg_request *
1995sg_add_request(Sg_fd * sfp)
1996{
1997 int k;
1998 unsigned long iflags;
1999 Sg_request *resp;
2000 Sg_request *rp = sfp->req_arr;
2001
2002 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2003 resp = sfp->headrp;
2004 if (!resp) {
2005 memset(rp, 0, sizeof (Sg_request));
2006 rp->parentfp = sfp;
2007 resp = rp;
2008 sfp->headrp = resp;
2009 } else {
2010 if (0 == sfp->cmd_q)
2011 resp = NULL; /* command queuing disallowed */
2012 else {
2013 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2014 if (!rp->parentfp)
2015 break;
2016 }
2017 if (k < SG_MAX_QUEUE) {
2018 memset(rp, 0, sizeof (Sg_request));
2019 rp->parentfp = sfp;
2020 while (resp->nextrp)
2021 resp = resp->nextrp;
2022 resp->nextrp = rp;
2023 resp = rp;
2024 } else
2025 resp = NULL;
2026 }
2027 }
2028 if (resp) {
2029 resp->nextrp = NULL;
cb59e840 2030 resp->header.duration = jiffies_to_msecs(jiffies);
1da177e4
LT		 2031 }
2032 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2033 return resp;
2034}
2035
2036/* Return of 1 for found; 0 for not found */
2037static int
2038sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2039{
2040 Sg_request *prev_rp;
2041 Sg_request *rp;
2042 unsigned long iflags;
2043 int res = 0;
2044
2045 if ((!sfp) || (!srp) || (!sfp->headrp))
2046 return res;
2047 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2048 prev_rp = sfp->headrp;
2049 if (srp == prev_rp) {
2050 sfp->headrp = prev_rp->nextrp;
2051 prev_rp->parentfp = NULL;
2052 res = 1;
2053 } else {
2054 while ((rp = prev_rp->nextrp)) {
2055 if (srp == rp) {
2056 prev_rp->nextrp = rp->nextrp;
2057 rp->parentfp = NULL;
2058 res = 1;
2059 break;
2060 }
2061 prev_rp = rp;
2062 }
2063 }
2064 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2065 return res;
2066}
2067
1da177e4
LT		 2068static Sg_fd *
2069sg_add_sfp(Sg_device * sdp, int dev)
2070{
2071 Sg_fd *sfp;
2072 unsigned long iflags;
44ec9542 2073 int bufflen;
1da177e4 2074
d6b10348 2075 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
1da177e4
LT		 2076 if (!sfp)
2077 return NULL;
d6b10348 2078
1da177e4
LT		 2079 init_waitqueue_head(&sfp->read_wait);
2080 rwlock_init(&sfp->rq_list_lock);
2081
c6517b79 2082 kref_init(&sfp->f_ref);
1da177e4
LT		 2083 sfp->timeout = SG_DEFAULT_TIMEOUT;
2084 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2085 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2086 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2087 sdp->device->host->unchecked_isa_dma : 1;
2088 sfp->cmd_q = SG_DEF_COMMAND_Q;
2089 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2090 sfp->parentdp = sdp;
7c07d613 2091 write_lock_irqsave(&sg_index_lock, iflags);
3442f802 2092 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
7c07d613 2093 write_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4 2094 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
6460e75a
DG		 2095 if (unlikely(sg_big_buff != def_reserved_size))
2096 sg_big_buff = def_reserved_size;
2097
44ec9542 2098 bufflen = min_t(int, sg_big_buff,
ae03bf63 2099 queue_max_sectors(sdp->device->request_queue) * 512);
44ec9542 2100 sg_build_reserve(sfp, bufflen);
1da177e4
LT		 2101 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2102 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
c6517b79
TB		 2103
2104 kref_get(&sdp->d_ref);
2105 __module_get(THIS_MODULE);
1da177e4
LT		 2106 return sfp;
2107}
2108
c6517b79 2109static void sg_remove_sfp_usercontext(struct work_struct *work)
1da177e4 2110{
c6517b79
TB		 2111 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2112 struct sg_device *sdp = sfp->parentdp;
2113
2114 /* Cleanup any responses which were never read(). */
2115 while (sfp->headrp)
2116 sg_finish_rem_req(sfp->headrp);
1da177e4 2117
1da177e4 2118 if (sfp->reserve.bufflen > 0) {
c6517b79
TB		 2119 SCSI_LOG_TIMEOUT(6,
2120 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2121 (int) sfp->reserve.bufflen,
2122 (int) sfp->reserve.k_use_sg));
1da177e4
LT		 2123 sg_remove_scat(&sfp->reserve);
2124 }
c6517b79
TB		 2125
2126 SCSI_LOG_TIMEOUT(6,
2127 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2128 sdp->disk->disk_name,
2129 sfp));
d6b10348 2130 kfree(sfp);
c6517b79
TB		 2131
2132 scsi_device_put(sdp->device);
2133 sg_put_dev(sdp);
2134 module_put(THIS_MODULE);
1da177e4
LT		 2135}
2136
c6517b79 2137static void sg_remove_sfp(struct kref *kref)
1da177e4 2138{
c6517b79
TB		 2139 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2140 struct sg_device *sdp = sfp->parentdp;
c6517b79 2141 unsigned long iflags;
1da177e4 2142
c6517b79 2143 write_lock_irqsave(&sg_index_lock, iflags);
3442f802 2144 list_del(&sfp->sfd_siblings);
c6517b79
TB		 2145 write_unlock_irqrestore(&sg_index_lock, iflags);
2146 wake_up_interruptible(&sdp->o_excl_wait);
1da177e4 2147
015640ed
FT		 2148 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2149 schedule_work(&sfp->ew.work);
1da177e4
LT		 2150}
2151
2152static int
2153sg_res_in_use(Sg_fd * sfp)
2154{
2155 const Sg_request *srp;
2156 unsigned long iflags;
2157
2158 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2159 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2160 if (srp->res_used)
2161 break;
2162 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2163 return srp ? 1 : 0;
2164}
2165
1da177e4 2166#ifdef CONFIG_SCSI_PROC_FS
7c07d613
JB		 2167static int
2168sg_idr_max_id(int id, void *p, void *data)
2169{
2170 int *k = data;
2171
2172 if (*k < id)
2173 *k = id;
2174
2175 return 0;
2176}
2177
1da177e4
LT		 2178static int
2179sg_last_dev(void)
2180{
53474c04 2181 int k = -1;
1da177e4
LT		 2182 unsigned long iflags;
2183
7c07d613
JB		 2184 read_lock_irqsave(&sg_index_lock, iflags);
2185 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2186 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT		 2187 return k + 1; /* origin 1 */
2188}
2189#endif
2190
c6517b79
TB		 2191/* must be called with sg_index_lock held */
2192static Sg_device *sg_lookup_dev(int dev)
1da177e4 2193{
c6517b79
TB		 2194 return idr_find(&sg_index_idr, dev);
2195}
1da177e4 2196
c6517b79
TB		 2197static Sg_device *sg_get_dev(int dev)
2198{
2199 struct sg_device *sdp;
2200 unsigned long flags;
2201
2202 read_lock_irqsave(&sg_index_lock, flags);
2203 sdp = sg_lookup_dev(dev);
2204 if (!sdp)
2205 sdp = ERR_PTR(-ENXIO);
2206 else if (sdp->detached) {
2207 /* If sdp->detached, then the refcount may already be 0, in
2208 * which case it would be a bug to do kref_get().
2209 */
2210 sdp = ERR_PTR(-ENODEV);
2211 } else
2212 kref_get(&sdp->d_ref);
2213 read_unlock_irqrestore(&sg_index_lock, flags);
7c07d613 2214
1da177e4
LT		 2215 return sdp;
2216}
2217
c6517b79
TB		 2218static void sg_put_dev(struct sg_device *sdp)
2219{
2220 kref_put(&sdp->d_ref, sg_device_destroy);
2221}
2222
1da177e4
LT		 2223#ifdef CONFIG_SCSI_PROC_FS
2224
2225static struct proc_dir_entry *sg_proc_sgp = NULL;
2226
2227static char sg_proc_sg_dirname[] = "scsi/sg";
2228
2229static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2230
2231static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2232static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2233 size_t count, loff_t *off);
828c0950
AD		 2234static const struct file_operations adio_fops = {
2235 .owner = THIS_MODULE,
1da177e4 2236 .open = sg_proc_single_open_adio,
828c0950
AD		 2237 .read = seq_read,
2238 .llseek = seq_lseek,
1da177e4
LT		 2239 .write = sg_proc_write_adio,
2240 .release = single_release,
2241};
2242
2243static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2244static ssize_t sg_proc_write_dressz(struct file *filp,
2245 const char __user *buffer, size_t count, loff_t *off);
828c0950
AD		 2246static const struct file_operations dressz_fops = {
2247 .owner = THIS_MODULE,
1da177e4 2248 .open = sg_proc_single_open_dressz,
828c0950
AD		 2249 .read = seq_read,
2250 .llseek = seq_lseek,
1da177e4
LT		 2251 .write = sg_proc_write_dressz,
2252 .release = single_release,
2253};
2254
2255static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2256static int sg_proc_single_open_version(struct inode *inode, struct file *file);
828c0950
AD		 2257static const struct file_operations version_fops = {
2258 .owner = THIS_MODULE,
1da177e4 2259 .open = sg_proc_single_open_version,
828c0950
AD		 2260 .read = seq_read,
2261 .llseek = seq_lseek,
1da177e4
LT		 2262 .release = single_release,
2263};
2264
2265static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2266static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
828c0950
AD		 2267static const struct file_operations devhdr_fops = {
2268 .owner = THIS_MODULE,
1da177e4 2269 .open = sg_proc_single_open_devhdr,
828c0950
AD		 2270 .read = seq_read,
2271 .llseek = seq_lseek,
1da177e4
LT		 2272 .release = single_release,
2273};
2274
2275static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2276static int sg_proc_open_dev(struct inode *inode, struct file *file);
2277static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2278static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2279static void dev_seq_stop(struct seq_file *s, void *v);
828c0950
AD		 2280static const struct file_operations dev_fops = {
2281 .owner = THIS_MODULE,
1da177e4 2282 .open = sg_proc_open_dev,
828c0950
AD		 2283 .read = seq_read,
2284 .llseek = seq_lseek,
1da177e4
LT		 2285 .release = seq_release,
2286};
88e9d34c 2287static const struct seq_operations dev_seq_ops = {
1da177e4
LT		 2288 .start = dev_seq_start,
2289 .next = dev_seq_next,
2290 .stop = dev_seq_stop,
2291 .show = sg_proc_seq_show_dev,
2292};
2293
2294static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2295static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
828c0950
AD		 2296static const struct file_operations devstrs_fops = {
2297 .owner = THIS_MODULE,
1da177e4 2298 .open = sg_proc_open_devstrs,
828c0950
AD		 2299 .read = seq_read,
2300 .llseek = seq_lseek,
1da177e4
LT		 2301 .release = seq_release,
2302};
88e9d34c 2303static const struct seq_operations devstrs_seq_ops = {
1da177e4
LT		 2304 .start = dev_seq_start,
2305 .next = dev_seq_next,
2306 .stop = dev_seq_stop,
2307 .show = sg_proc_seq_show_devstrs,
2308};
2309
2310static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2311static int sg_proc_open_debug(struct inode *inode, struct file *file);
828c0950
AD		 2312static const struct file_operations debug_fops = {
2313 .owner = THIS_MODULE,
1da177e4 2314 .open = sg_proc_open_debug,
828c0950
AD		 2315 .read = seq_read,
2316 .llseek = seq_lseek,
1da177e4
LT		 2317 .release = seq_release,
2318};
88e9d34c 2319static const struct seq_operations debug_seq_ops = {
1da177e4
LT		 2320 .start = dev_seq_start,
2321 .next = dev_seq_next,
2322 .stop = dev_seq_stop,
2323 .show = sg_proc_seq_show_debug,
2324};
2325
2326
2327struct sg_proc_leaf {
2328 const char * name;
828c0950 2329 const struct file_operations * fops;
1da177e4
LT		 2330};
2331
2332static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2333 {"allow_dio", &adio_fops},
2334 {"debug", &debug_fops},
2335 {"def_reserved_size", &dressz_fops},
2336 {"device_hdr", &devhdr_fops},
2337 {"devices", &dev_fops},
2338 {"device_strs", &devstrs_fops},
2339 {"version", &version_fops}
2340};
2341
2342static int
2343sg_proc_init(void)
2344{
6391a113 2345 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
d161a13f 2346 int k;
1da177e4 2347
66600221 2348 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
1da177e4
LT		 2349 if (!sg_proc_sgp)
2350 return 1;
2351 for (k = 0; k < num_leaves; ++k) {
d161a13f
AV		 2352 struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
2353 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
a973909f 2354 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
1da177e4
LT		 2355 }
2356 return 0;
2357}
2358
2359static void
2360sg_proc_cleanup(void)
2361{
2362 int k;
6391a113 2363 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
1da177e4
LT		 2364
2365 if (!sg_proc_sgp)
2366 return;
2367 for (k = 0; k < num_leaves; ++k)
2368 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2369 remove_proc_entry(sg_proc_sg_dirname, NULL);
2370}
2371
2372
2373static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2374{
2375 seq_printf(s, "%d\n", *((int *)s->private));
2376 return 0;
2377}
2378
2379static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2380{
2381 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2382}
2383
2384static ssize_t
2385sg_proc_write_adio(struct file *filp, const char __user *buffer,
2386 size_t count, loff_t *off)
2387{
7e95fffe
SB		 2388 int err;
2389 unsigned long num;
1da177e4
LT		 2390
2391 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2392 return -EACCES;
7e95fffe
SB		 2393 err = kstrtoul_from_user(buffer, count, 0, &num);
2394 if (err)
2395 return err;
2396 sg_allow_dio = num ? 1 : 0;
1da177e4
LT		 2397 return count;
2398}
2399
2400static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2401{
2402 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2403}
2404
2405static ssize_t
2406sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2407 size_t count, loff_t *off)
2408{
7e95fffe 2409 int err;
1da177e4 2410 unsigned long k = ULONG_MAX;
1da177e4
LT		 2411
2412 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2413 return -EACCES;
7e95fffe
SB		 2414
2415 err = kstrtoul_from_user(buffer, count, 0, &k);
2416 if (err)
2417 return err;
1da177e4
LT		 2418 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2419 sg_big_buff = k;
2420 return count;
2421 }
2422 return -ERANGE;
2423}
2424
2425static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2426{
2427 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2428 sg_version_date);
2429 return 0;
2430}
2431
2432static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2433{
2434 return single_open(file, sg_proc_seq_show_version, NULL);
2435}
2436
2437static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2438{
2439 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2440 "online\n");
2441 return 0;
2442}
2443
2444static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2445{
2446 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2447}
2448
2449struct sg_proc_deviter {
2450 loff_t index;
2451 size_t max;
2452};
2453
2454static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2455{
2456 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2457
729d70f5 2458 s->private = it;
1da177e4
LT		 2459 if (! it)
2460 return NULL;
729d70f5 2461
1da177e4
LT		 2462 it->index = *pos;
2463 it->max = sg_last_dev();
2464 if (it->index >= it->max)
729d70f5 2465 return NULL;
1da177e4 2466 return it;
1da177e4
LT		 2467}
2468
2469static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2470{
729d70f5 2471 struct sg_proc_deviter * it = s->private;
1da177e4
LT		 2472
2473 *pos = ++it->index;
2474 return (it->index < it->max) ? it : NULL;
2475}
2476
2477static void dev_seq_stop(struct seq_file *s, void *v)
2478{
729d70f5 2479 kfree(s->private);
1da177e4
LT		 2480}
2481
2482static int sg_proc_open_dev(struct inode *inode, struct file *file)
2483{
2484 return seq_open(file, &dev_seq_ops);
2485}
2486
2487static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2488{
2489 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2490 Sg_device *sdp;
2491 struct scsi_device *scsidp;
c6517b79 2492 unsigned long iflags;
1da177e4 2493
c6517b79
TB		 2494 read_lock_irqsave(&sg_index_lock, iflags);
2495 sdp = it ? sg_lookup_dev(it->index) : NULL;
1da177e4
LT		 2496 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2497 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2498 scsidp->host->host_no, scsidp->channel,
2499 scsidp->id, scsidp->lun, (int) scsidp->type,
2500 1,
2501 (int) scsidp->queue_depth,
2502 (int) scsidp->device_busy,
2503 (int) scsi_device_online(scsidp));
2504 else
2505 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
c6517b79 2506 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT		 2507 return 0;
2508}
2509
2510static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2511{
2512 return seq_open(file, &devstrs_seq_ops);
2513}
2514
2515static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2516{
2517 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2518 Sg_device *sdp;
2519 struct scsi_device *scsidp;
c6517b79 2520 unsigned long iflags;
1da177e4 2521
c6517b79
TB		 2522 read_lock_irqsave(&sg_index_lock, iflags);
2523 sdp = it ? sg_lookup_dev(it->index) : NULL;
1da177e4
LT		 2524 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2525 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2526 scsidp->vendor, scsidp->model, scsidp->rev);
2527 else
2528 seq_printf(s, "<no active device>\n");
c6517b79 2529 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT		 2530 return 0;
2531}
2532
c6517b79 2533/* must be called while holding sg_index_lock */
1da177e4
LT		 2534static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2535{
2536 int k, m, new_interface, blen, usg;
2537 Sg_request *srp;
2538 Sg_fd *fp;
2539 const sg_io_hdr_t *hp;
2540 const char * cp;
cb59e840 2541 unsigned int ms;
1da177e4 2542
3442f802
FT		 2543 k = 0;
2544 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2545 k++;
c6517b79 2546 read_lock(&fp->rq_list_lock); /* irqs already disabled */
1da177e4 2547 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
3442f802 2548 "(res)sgat=%d low_dma=%d\n", k,
1da177e4
LT		 2549 jiffies_to_msecs(fp->timeout),
2550 fp->reserve.bufflen,
2551 (int) fp->reserve.k_use_sg,
2552 (int) fp->low_dma);
ebaf466b 2553 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
1da177e4 2554 (int) fp->cmd_q, (int) fp->force_packid,
ebaf466b 2555 (int) fp->keep_orphan);
c6517b79
TB		 2556 for (m = 0, srp = fp->headrp;
2557 srp != NULL;
2558 ++m, srp = srp->nextrp) {
1da177e4
LT		 2559 hp = &srp->header;
2560 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2561 if (srp->res_used) {
2562 if (new_interface &&
2563 (SG_FLAG_MMAP_IO & hp->flags))
2564 cp = " mmap>> ";
2565 else
2566 cp = " rb>> ";
2567 } else {
2568 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2569 cp = " dio>> ";
2570 else
2571 cp = " ";
2572 }
2573 seq_printf(s, cp);
d6b10348
MC		 2574 blen = srp->data.bufflen;
2575 usg = srp->data.k_use_sg;
1da177e4
LT		 2576 seq_printf(s, srp->done ?
2577 ((1 == srp->done) ? "rcv:" : "fin:")
d6b10348 2578 : "act:");
1da177e4
LT		 2579 seq_printf(s, " id=%d blen=%d",
2580 srp->header.pack_id, blen);
2581 if (srp->done)
2582 seq_printf(s, " dur=%d", hp->duration);
cb59e840 2583 else {
2584 ms = jiffies_to_msecs(jiffies);
1da177e4 2585 seq_printf(s, " t_o/elap=%d/%d",
cb59e840 2586 (new_interface ? hp->timeout :
2587 jiffies_to_msecs(fp->timeout)),
2588 (ms > hp->duration ? ms - hp->duration : 0));
2589 }
1da177e4
LT		 2590 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2591 (int) srp->data.cmd_opcode);
2592 }
2593 if (0 == m)
2594 seq_printf(s, " No requests active\n");
c6517b79 2595 read_unlock(&fp->rq_list_lock);
1da177e4
LT		 2596 }
2597}
2598
2599static int sg_proc_open_debug(struct inode *inode, struct file *file)
2600{
2601 return seq_open(file, &debug_seq_ops);
2602}
2603
2604static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2605{
2606 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2607 Sg_device *sdp;
c6517b79 2608 unsigned long iflags;
1da177e4
LT		 2609
2610 if (it && (0 == it->index)) {
7c07d613
JB		 2611 seq_printf(s, "max_active_device=%d(origin 1)\n",
2612 (int)it->max);
1da177e4
LT		 2613 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2614 }
1da177e4 2615
c6517b79
TB		 2616 read_lock_irqsave(&sg_index_lock, iflags);
2617 sdp = it ? sg_lookup_dev(it->index) : NULL;
3442f802 2618 if (sdp && !list_empty(&sdp->sfds)) {
c6517b79 2619 struct scsi_device *scsidp = sdp->device;
1da177e4 2620
c6517b79
TB		 2621 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2622 if (sdp->detached)
2623 seq_printf(s, "detached pending close ");
2624 else
2625 seq_printf
2626 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2627 scsidp->host->host_no,
2628 scsidp->channel, scsidp->id,
2629 scsidp->lun,
2630 scsidp->host->hostt->emulated);
2631 seq_printf(s, " sg_tablesize=%d excl=%d\n",
b499e524 2632 sdp->sg_tablesize, get_exclude(sdp));
1da177e4
LT		 2633 sg_proc_debug_helper(s, sdp);
2634 }
c6517b79 2635 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT		 2636 return 0;
2637}
2638
2639#endif /* CONFIG_SCSI_PROC_FS */
2640
2641module_init(init_sg);
2642module_exit(exit_sg);
Linux kernel - Deliverables
This page took 1.09092 seconds and 5 git commands to generate.