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