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