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