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