]> 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
UBUNTU: Ubuntu-4.13.0-45.50
[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 void
832 sg_fill_request_table(Sg_fd *sfp, sg_req_info_t *rinfo)
833 {
834 Sg_request *srp;
835 int val;
836 unsigned int ms;
837
838 val = 0;
839 list_for_each_entry(srp, &sfp->rq_list, entry) {
840 if (val >= SG_MAX_QUEUE)
841 break;
842 rinfo[val].req_state = srp->done + 1;
843 rinfo[val].problem =
844 srp->header.masked_status &
845 srp->header.host_status &
846 srp->header.driver_status;
847 if (srp->done)
848 rinfo[val].duration =
849 srp->header.duration;
850 else {
851 ms = jiffies_to_msecs(jiffies);
852 rinfo[val].duration =
853 (ms > srp->header.duration) ?
854 (ms - srp->header.duration) : 0;
855 }
856 rinfo[val].orphan = srp->orphan;
857 rinfo[val].sg_io_owned = srp->sg_io_owned;
858 rinfo[val].pack_id = srp->header.pack_id;
859 rinfo[val].usr_ptr = srp->header.usr_ptr;
860 val++;
861 }
862 }
863
864 static long
865 sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
866 {
867 void __user *p = (void __user *)arg;
868 int __user *ip = p;
869 int result, val, read_only;
870 Sg_device *sdp;
871 Sg_fd *sfp;
872 Sg_request *srp;
873 unsigned long iflags;
874
875 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
876 return -ENXIO;
877
878 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
879 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
880 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
881
882 switch (cmd_in) {
883 case SG_IO:
884 if (atomic_read(&sdp->detaching))
885 return -ENODEV;
886 if (!scsi_block_when_processing_errors(sdp->device))
887 return -ENXIO;
888 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
889 return -EFAULT;
890 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
891 1, read_only, 1, &srp);
892 if (result < 0)
893 return result;
894 result = wait_event_interruptible(sfp->read_wait,
895 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
896 if (atomic_read(&sdp->detaching))
897 return -ENODEV;
898 write_lock_irq(&sfp->rq_list_lock);
899 if (srp->done) {
900 srp->done = 2;
901 write_unlock_irq(&sfp->rq_list_lock);
902 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
903 return (result < 0) ? result : 0;
904 }
905 srp->orphan = 1;
906 write_unlock_irq(&sfp->rq_list_lock);
907 return result; /* -ERESTARTSYS because signal hit process */
908 case SG_SET_TIMEOUT:
909 result = get_user(val, ip);
910 if (result)
911 return result;
912 if (val < 0)
913 return -EIO;
914 if (val >= mult_frac((s64)INT_MAX, USER_HZ, HZ))
915 val = min_t(s64, mult_frac((s64)INT_MAX, USER_HZ, HZ),
916 INT_MAX);
917 sfp->timeout_user = val;
918 sfp->timeout = mult_frac(val, HZ, USER_HZ);
919
920 return 0;
921 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
922 /* strange ..., for backward compatibility */
923 return sfp->timeout_user;
924 case SG_SET_FORCE_LOW_DMA:
925 /*
926 * N.B. This ioctl never worked properly, but failed to
927 * return an error value. So returning '0' to keep compability
928 * with legacy applications.
929 */
930 return 0;
931 case SG_GET_LOW_DMA:
932 return put_user((int) sdp->device->host->unchecked_isa_dma, ip);
933 case SG_GET_SCSI_ID:
934 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
935 return -EFAULT;
936 else {
937 sg_scsi_id_t __user *sg_idp = p;
938
939 if (atomic_read(&sdp->detaching))
940 return -ENODEV;
941 __put_user((int) sdp->device->host->host_no,
942 &sg_idp->host_no);
943 __put_user((int) sdp->device->channel,
944 &sg_idp->channel);
945 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
946 __put_user((int) sdp->device->lun, &sg_idp->lun);
947 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
948 __put_user((short) sdp->device->host->cmd_per_lun,
949 &sg_idp->h_cmd_per_lun);
950 __put_user((short) sdp->device->queue_depth,
951 &sg_idp->d_queue_depth);
952 __put_user(0, &sg_idp->unused[0]);
953 __put_user(0, &sg_idp->unused[1]);
954 return 0;
955 }
956 case SG_SET_FORCE_PACK_ID:
957 result = get_user(val, ip);
958 if (result)
959 return result;
960 sfp->force_packid = val ? 1 : 0;
961 return 0;
962 case SG_GET_PACK_ID:
963 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
964 return -EFAULT;
965 read_lock_irqsave(&sfp->rq_list_lock, iflags);
966 list_for_each_entry(srp, &sfp->rq_list, entry) {
967 if ((1 == srp->done) && (!srp->sg_io_owned)) {
968 read_unlock_irqrestore(&sfp->rq_list_lock,
969 iflags);
970 __put_user(srp->header.pack_id, ip);
971 return 0;
972 }
973 }
974 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
975 __put_user(-1, ip);
976 return 0;
977 case SG_GET_NUM_WAITING:
978 read_lock_irqsave(&sfp->rq_list_lock, iflags);
979 val = 0;
980 list_for_each_entry(srp, &sfp->rq_list, entry) {
981 if ((1 == srp->done) && (!srp->sg_io_owned))
982 ++val;
983 }
984 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
985 return put_user(val, ip);
986 case SG_GET_SG_TABLESIZE:
987 return put_user(sdp->sg_tablesize, ip);
988 case SG_SET_RESERVED_SIZE:
989 result = get_user(val, ip);
990 if (result)
991 return result;
992 if (val < 0)
993 return -EINVAL;
994 val = min_t(int, val,
995 max_sectors_bytes(sdp->device->request_queue));
996 mutex_lock(&sfp->f_mutex);
997 if (val != sfp->reserve.bufflen) {
998 if (sfp->mmap_called ||
999 sfp->res_in_use) {
1000 mutex_unlock(&sfp->f_mutex);
1001 return -EBUSY;
1002 }
1003
1004 sg_remove_scat(sfp, &sfp->reserve);
1005 sg_build_reserve(sfp, val);
1006 }
1007 mutex_unlock(&sfp->f_mutex);
1008 return 0;
1009 case SG_GET_RESERVED_SIZE:
1010 val = min_t(int, sfp->reserve.bufflen,
1011 max_sectors_bytes(sdp->device->request_queue));
1012 return put_user(val, ip);
1013 case SG_SET_COMMAND_Q:
1014 result = get_user(val, ip);
1015 if (result)
1016 return result;
1017 sfp->cmd_q = val ? 1 : 0;
1018 return 0;
1019 case SG_GET_COMMAND_Q:
1020 return put_user((int) sfp->cmd_q, ip);
1021 case SG_SET_KEEP_ORPHAN:
1022 result = get_user(val, ip);
1023 if (result)
1024 return result;
1025 sfp->keep_orphan = val;
1026 return 0;
1027 case SG_GET_KEEP_ORPHAN:
1028 return put_user((int) sfp->keep_orphan, ip);
1029 case SG_NEXT_CMD_LEN:
1030 result = get_user(val, ip);
1031 if (result)
1032 return result;
1033 if (val > SG_MAX_CDB_SIZE)
1034 return -ENOMEM;
1035 sfp->next_cmd_len = (val > 0) ? val : 0;
1036 return 0;
1037 case SG_GET_VERSION_NUM:
1038 return put_user(sg_version_num, ip);
1039 case SG_GET_ACCESS_COUNT:
1040 /* faked - we don't have a real access count anymore */
1041 val = (sdp->device ? 1 : 0);
1042 return put_user(val, ip);
1043 case SG_GET_REQUEST_TABLE:
1044 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1045 return -EFAULT;
1046 else {
1047 sg_req_info_t *rinfo;
1048
1049 rinfo = kzalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1050 GFP_KERNEL);
1051 if (!rinfo)
1052 return -ENOMEM;
1053 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1054 sg_fill_request_table(sfp, rinfo);
1055 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1056 result = __copy_to_user(p, rinfo,
1057 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1058 result = result ? -EFAULT : 0;
1059 kfree(rinfo);
1060 return result;
1061 }
1062 case SG_EMULATED_HOST:
1063 if (atomic_read(&sdp->detaching))
1064 return -ENODEV;
1065 return put_user(sdp->device->host->hostt->emulated, ip);
1066 case SCSI_IOCTL_SEND_COMMAND:
1067 if (atomic_read(&sdp->detaching))
1068 return -ENODEV;
1069 if (read_only) {
1070 unsigned char opcode = WRITE_6;
1071 Scsi_Ioctl_Command __user *siocp = p;
1072
1073 if (copy_from_user(&opcode, siocp->data, 1))
1074 return -EFAULT;
1075 if (sg_allow_access(filp, &opcode))
1076 return -EPERM;
1077 }
1078 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1079 case SG_SET_DEBUG:
1080 result = get_user(val, ip);
1081 if (result)
1082 return result;
1083 sdp->sgdebug = (char) val;
1084 return 0;
1085 case BLKSECTGET:
1086 return put_user(max_sectors_bytes(sdp->device->request_queue),
1087 ip);
1088 case BLKTRACESETUP:
1089 return blk_trace_setup(sdp->device->request_queue,
1090 sdp->disk->disk_name,
1091 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1092 NULL,
1093 (char *)arg);
1094 case BLKTRACESTART:
1095 return blk_trace_startstop(sdp->device->request_queue, 1);
1096 case BLKTRACESTOP:
1097 return blk_trace_startstop(sdp->device->request_queue, 0);
1098 case BLKTRACETEARDOWN:
1099 return blk_trace_remove(sdp->device->request_queue);
1100 case SCSI_IOCTL_GET_IDLUN:
1101 case SCSI_IOCTL_GET_BUS_NUMBER:
1102 case SCSI_IOCTL_PROBE_HOST:
1103 case SG_GET_TRANSFORM:
1104 case SG_SCSI_RESET:
1105 if (atomic_read(&sdp->detaching))
1106 return -ENODEV;
1107 break;
1108 default:
1109 if (read_only)
1110 return -EPERM; /* don't know so take safe approach */
1111 break;
1112 }
1113
1114 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1115 cmd_in, filp->f_flags & O_NDELAY);
1116 if (result)
1117 return result;
1118 return scsi_ioctl(sdp->device, cmd_in, p);
1119 }
1120
1121 #ifdef CONFIG_COMPAT
1122 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1123 {
1124 Sg_device *sdp;
1125 Sg_fd *sfp;
1126 struct scsi_device *sdev;
1127
1128 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1129 return -ENXIO;
1130
1131 sdev = sdp->device;
1132 if (sdev->host->hostt->compat_ioctl) {
1133 int ret;
1134
1135 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1136
1137 return ret;
1138 }
1139
1140 return -ENOIOCTLCMD;
1141 }
1142 #endif
1143
1144 static unsigned int
1145 sg_poll(struct file *filp, poll_table * wait)
1146 {
1147 unsigned int res = 0;
1148 Sg_device *sdp;
1149 Sg_fd *sfp;
1150 Sg_request *srp;
1151 int count = 0;
1152 unsigned long iflags;
1153
1154 sfp = filp->private_data;
1155 if (!sfp)
1156 return POLLERR;
1157 sdp = sfp->parentdp;
1158 if (!sdp)
1159 return POLLERR;
1160 poll_wait(filp, &sfp->read_wait, wait);
1161 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1162 list_for_each_entry(srp, &sfp->rq_list, entry) {
1163 /* if any read waiting, flag it */
1164 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1165 res = POLLIN | POLLRDNORM;
1166 ++count;
1167 }
1168 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1169
1170 if (atomic_read(&sdp->detaching))
1171 res |= POLLHUP;
1172 else if (!sfp->cmd_q) {
1173 if (0 == count)
1174 res |= POLLOUT | POLLWRNORM;
1175 } else if (count < SG_MAX_QUEUE)
1176 res |= POLLOUT | POLLWRNORM;
1177 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1178 "sg_poll: res=0x%x\n", (int) res));
1179 return res;
1180 }
1181
1182 static int
1183 sg_fasync(int fd, struct file *filp, int mode)
1184 {
1185 Sg_device *sdp;
1186 Sg_fd *sfp;
1187
1188 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1189 return -ENXIO;
1190 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1191 "sg_fasync: mode=%d\n", mode));
1192
1193 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1194 }
1195
1196 static int
1197 sg_vma_fault(struct vm_fault *vmf)
1198 {
1199 struct vm_area_struct *vma = vmf->vma;
1200 Sg_fd *sfp;
1201 unsigned long offset, len, sa;
1202 Sg_scatter_hold *rsv_schp;
1203 int k, length;
1204
1205 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1206 return VM_FAULT_SIGBUS;
1207 rsv_schp = &sfp->reserve;
1208 offset = vmf->pgoff << PAGE_SHIFT;
1209 if (offset >= rsv_schp->bufflen)
1210 return VM_FAULT_SIGBUS;
1211 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1212 "sg_vma_fault: offset=%lu, scatg=%d\n",
1213 offset, rsv_schp->k_use_sg));
1214 sa = vma->vm_start;
1215 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1216 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1217 len = vma->vm_end - sa;
1218 len = (len < length) ? len : length;
1219 if (offset < len) {
1220 struct page *page = nth_page(rsv_schp->pages[k],
1221 offset >> PAGE_SHIFT);
1222 get_page(page); /* increment page count */
1223 vmf->page = page;
1224 return 0; /* success */
1225 }
1226 sa += len;
1227 offset -= len;
1228 }
1229
1230 return VM_FAULT_SIGBUS;
1231 }
1232
1233 static const struct vm_operations_struct sg_mmap_vm_ops = {
1234 .fault = sg_vma_fault,
1235 };
1236
1237 static int
1238 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1239 {
1240 Sg_fd *sfp;
1241 unsigned long req_sz, len, sa;
1242 Sg_scatter_hold *rsv_schp;
1243 int k, length;
1244 int ret = 0;
1245
1246 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1247 return -ENXIO;
1248 req_sz = vma->vm_end - vma->vm_start;
1249 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1250 "sg_mmap starting, vm_start=%p, len=%d\n",
1251 (void *) vma->vm_start, (int) req_sz));
1252 if (vma->vm_pgoff)
1253 return -EINVAL; /* want no offset */
1254 rsv_schp = &sfp->reserve;
1255 mutex_lock(&sfp->f_mutex);
1256 if (req_sz > rsv_schp->bufflen) {
1257 ret = -ENOMEM; /* cannot map more than reserved buffer */
1258 goto out;
1259 }
1260
1261 sa = vma->vm_start;
1262 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1263 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1264 len = vma->vm_end - sa;
1265 len = (len < length) ? len : length;
1266 sa += len;
1267 }
1268
1269 sfp->mmap_called = 1;
1270 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
1271 vma->vm_private_data = sfp;
1272 vma->vm_ops = &sg_mmap_vm_ops;
1273 out:
1274 mutex_unlock(&sfp->f_mutex);
1275 return ret;
1276 }
1277
1278 static void
1279 sg_rq_end_io_usercontext(struct work_struct *work)
1280 {
1281 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1282 struct sg_fd *sfp = srp->parentfp;
1283
1284 sg_finish_rem_req(srp);
1285 sg_remove_request(sfp, srp);
1286 kref_put(&sfp->f_ref, sg_remove_sfp);
1287 }
1288
1289 /*
1290 * This function is a "bottom half" handler that is called by the mid
1291 * level when a command is completed (or has failed).
1292 */
1293 static void
1294 sg_rq_end_io(struct request *rq, blk_status_t status)
1295 {
1296 struct sg_request *srp = rq->end_io_data;
1297 struct scsi_request *req = scsi_req(rq);
1298 Sg_device *sdp;
1299 Sg_fd *sfp;
1300 unsigned long iflags;
1301 unsigned int ms;
1302 char *sense;
1303 int result, resid, done = 1;
1304
1305 if (WARN_ON(srp->done != 0))
1306 return;
1307
1308 sfp = srp->parentfp;
1309 if (WARN_ON(sfp == NULL))
1310 return;
1311
1312 sdp = sfp->parentdp;
1313 if (unlikely(atomic_read(&sdp->detaching)))
1314 pr_info("%s: device detaching\n", __func__);
1315
1316 sense = req->sense;
1317 result = req->result;
1318 resid = req->resid_len;
1319
1320 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1321 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1322 srp->header.pack_id, result));
1323 srp->header.resid = resid;
1324 ms = jiffies_to_msecs(jiffies);
1325 srp->header.duration = (ms > srp->header.duration) ?
1326 (ms - srp->header.duration) : 0;
1327 if (0 != result) {
1328 struct scsi_sense_hdr sshdr;
1329
1330 srp->header.status = 0xff & result;
1331 srp->header.masked_status = status_byte(result);
1332 srp->header.msg_status = msg_byte(result);
1333 srp->header.host_status = host_byte(result);
1334 srp->header.driver_status = driver_byte(result);
1335 if ((sdp->sgdebug > 0) &&
1336 ((CHECK_CONDITION == srp->header.masked_status) ||
1337 (COMMAND_TERMINATED == srp->header.masked_status)))
1338 __scsi_print_sense(sdp->device, __func__, sense,
1339 SCSI_SENSE_BUFFERSIZE);
1340
1341 /* Following if statement is a patch supplied by Eric Youngdale */
1342 if (driver_byte(result) != 0
1343 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1344 && !scsi_sense_is_deferred(&sshdr)
1345 && sshdr.sense_key == UNIT_ATTENTION
1346 && sdp->device->removable) {
1347 /* Detected possible disc change. Set the bit - this */
1348 /* may be used if there are filesystems using this device */
1349 sdp->device->changed = 1;
1350 }
1351 }
1352
1353 if (req->sense_len)
1354 memcpy(srp->sense_b, req->sense, SCSI_SENSE_BUFFERSIZE);
1355
1356 /* Rely on write phase to clean out srp status values, so no "else" */
1357
1358 /*
1359 * Free the request as soon as it is complete so that its resources
1360 * can be reused without waiting for userspace to read() the
1361 * result. But keep the associated bio (if any) around until
1362 * blk_rq_unmap_user() can be called from user context.
1363 */
1364 srp->rq = NULL;
1365 scsi_req_free_cmd(scsi_req(rq));
1366 __blk_put_request(rq->q, rq);
1367
1368 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1369 if (unlikely(srp->orphan)) {
1370 if (sfp->keep_orphan)
1371 srp->sg_io_owned = 0;
1372 else
1373 done = 0;
1374 }
1375 srp->done = done;
1376 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1377
1378 if (likely(done)) {
1379 /* Now wake up any sg_read() that is waiting for this
1380 * packet.
1381 */
1382 wake_up_interruptible(&sfp->read_wait);
1383 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1384 kref_put(&sfp->f_ref, sg_remove_sfp);
1385 } else {
1386 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1387 schedule_work(&srp->ew.work);
1388 }
1389 }
1390
1391 static const struct file_operations sg_fops = {
1392 .owner = THIS_MODULE,
1393 .read = sg_read,
1394 .write = sg_write,
1395 .poll = sg_poll,
1396 .unlocked_ioctl = sg_ioctl,
1397 #ifdef CONFIG_COMPAT
1398 .compat_ioctl = sg_compat_ioctl,
1399 #endif
1400 .open = sg_open,
1401 .mmap = sg_mmap,
1402 .release = sg_release,
1403 .fasync = sg_fasync,
1404 .llseek = no_llseek,
1405 };
1406
1407 static struct class *sg_sysfs_class;
1408
1409 static int sg_sysfs_valid = 0;
1410
1411 static Sg_device *
1412 sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1413 {
1414 struct request_queue *q = scsidp->request_queue;
1415 Sg_device *sdp;
1416 unsigned long iflags;
1417 int error;
1418 u32 k;
1419
1420 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1421 if (!sdp) {
1422 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1423 "failure\n", __func__);
1424 return ERR_PTR(-ENOMEM);
1425 }
1426
1427 idr_preload(GFP_KERNEL);
1428 write_lock_irqsave(&sg_index_lock, iflags);
1429
1430 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1431 if (error < 0) {
1432 if (error == -ENOSPC) {
1433 sdev_printk(KERN_WARNING, scsidp,
1434 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1435 scsidp->type, SG_MAX_DEVS - 1);
1436 error = -ENODEV;
1437 } else {
1438 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1439 "allocation Sg_device failure: %d\n",
1440 __func__, error);
1441 }
1442 goto out_unlock;
1443 }
1444 k = error;
1445
1446 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1447 "sg_alloc: dev=%d \n", k));
1448 sprintf(disk->disk_name, "sg%d", k);
1449 disk->first_minor = k;
1450 sdp->disk = disk;
1451 sdp->device = scsidp;
1452 mutex_init(&sdp->open_rel_lock);
1453 INIT_LIST_HEAD(&sdp->sfds);
1454 init_waitqueue_head(&sdp->open_wait);
1455 atomic_set(&sdp->detaching, 0);
1456 rwlock_init(&sdp->sfd_lock);
1457 sdp->sg_tablesize = queue_max_segments(q);
1458 sdp->index = k;
1459 kref_init(&sdp->d_ref);
1460 error = 0;
1461
1462 out_unlock:
1463 write_unlock_irqrestore(&sg_index_lock, iflags);
1464 idr_preload_end();
1465
1466 if (error) {
1467 kfree(sdp);
1468 return ERR_PTR(error);
1469 }
1470 return sdp;
1471 }
1472
1473 static int
1474 sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
1475 {
1476 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1477 struct gendisk *disk;
1478 Sg_device *sdp = NULL;
1479 struct cdev * cdev = NULL;
1480 int error;
1481 unsigned long iflags;
1482
1483 disk = alloc_disk(1);
1484 if (!disk) {
1485 pr_warn("%s: alloc_disk failed\n", __func__);
1486 return -ENOMEM;
1487 }
1488 disk->major = SCSI_GENERIC_MAJOR;
1489
1490 error = -ENOMEM;
1491 cdev = cdev_alloc();
1492 if (!cdev) {
1493 pr_warn("%s: cdev_alloc failed\n", __func__);
1494 goto out;
1495 }
1496 cdev->owner = THIS_MODULE;
1497 cdev->ops = &sg_fops;
1498
1499 sdp = sg_alloc(disk, scsidp);
1500 if (IS_ERR(sdp)) {
1501 pr_warn("%s: sg_alloc failed\n", __func__);
1502 error = PTR_ERR(sdp);
1503 goto out;
1504 }
1505
1506 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1507 if (error)
1508 goto cdev_add_err;
1509
1510 sdp->cdev = cdev;
1511 if (sg_sysfs_valid) {
1512 struct device *sg_class_member;
1513
1514 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1515 MKDEV(SCSI_GENERIC_MAJOR,
1516 sdp->index),
1517 sdp, "%s", disk->disk_name);
1518 if (IS_ERR(sg_class_member)) {
1519 pr_err("%s: device_create failed\n", __func__);
1520 error = PTR_ERR(sg_class_member);
1521 goto cdev_add_err;
1522 }
1523 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1524 &sg_class_member->kobj, "generic");
1525 if (error)
1526 pr_err("%s: unable to make symlink 'generic' back "
1527 "to sg%d\n", __func__, sdp->index);
1528 } else
1529 pr_warn("%s: sg_sys Invalid\n", __func__);
1530
1531 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1532 "type %d\n", sdp->index, scsidp->type);
1533
1534 dev_set_drvdata(cl_dev, sdp);
1535
1536 return 0;
1537
1538 cdev_add_err:
1539 write_lock_irqsave(&sg_index_lock, iflags);
1540 idr_remove(&sg_index_idr, sdp->index);
1541 write_unlock_irqrestore(&sg_index_lock, iflags);
1542 kfree(sdp);
1543
1544 out:
1545 put_disk(disk);
1546 if (cdev)
1547 cdev_del(cdev);
1548 return error;
1549 }
1550
1551 static void
1552 sg_device_destroy(struct kref *kref)
1553 {
1554 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1555 unsigned long flags;
1556
1557 /* CAUTION! Note that the device can still be found via idr_find()
1558 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1559 * any other cleanup.
1560 */
1561
1562 write_lock_irqsave(&sg_index_lock, flags);
1563 idr_remove(&sg_index_idr, sdp->index);
1564 write_unlock_irqrestore(&sg_index_lock, flags);
1565
1566 SCSI_LOG_TIMEOUT(3,
1567 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
1568
1569 put_disk(sdp->disk);
1570 kfree(sdp);
1571 }
1572
1573 static void
1574 sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
1575 {
1576 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1577 Sg_device *sdp = dev_get_drvdata(cl_dev);
1578 unsigned long iflags;
1579 Sg_fd *sfp;
1580 int val;
1581
1582 if (!sdp)
1583 return;
1584 /* want sdp->detaching non-zero as soon as possible */
1585 val = atomic_inc_return(&sdp->detaching);
1586 if (val > 1)
1587 return; /* only want to do following once per device */
1588
1589 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1590 "%s\n", __func__));
1591
1592 read_lock_irqsave(&sdp->sfd_lock, iflags);
1593 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1594 wake_up_interruptible_all(&sfp->read_wait);
1595 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1596 }
1597 wake_up_interruptible_all(&sdp->open_wait);
1598 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
1599
1600 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1601 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1602 cdev_del(sdp->cdev);
1603 sdp->cdev = NULL;
1604
1605 kref_put(&sdp->d_ref, sg_device_destroy);
1606 }
1607
1608 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1609 module_param_named(def_reserved_size, def_reserved_size, int,
1610 S_IRUGO | S_IWUSR);
1611 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1612
1613 MODULE_AUTHOR("Douglas Gilbert");
1614 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1615 MODULE_LICENSE("GPL");
1616 MODULE_VERSION(SG_VERSION_STR);
1617 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1618
1619 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1620 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1621 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1622 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1623
1624 static int __init
1625 init_sg(void)
1626 {
1627 int rc;
1628
1629 if (scatter_elem_sz < PAGE_SIZE) {
1630 scatter_elem_sz = PAGE_SIZE;
1631 scatter_elem_sz_prev = scatter_elem_sz;
1632 }
1633 if (def_reserved_size >= 0)
1634 sg_big_buff = def_reserved_size;
1635 else
1636 def_reserved_size = sg_big_buff;
1637
1638 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1639 SG_MAX_DEVS, "sg");
1640 if (rc)
1641 return rc;
1642 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1643 if ( IS_ERR(sg_sysfs_class) ) {
1644 rc = PTR_ERR(sg_sysfs_class);
1645 goto err_out;
1646 }
1647 sg_sysfs_valid = 1;
1648 rc = scsi_register_interface(&sg_interface);
1649 if (0 == rc) {
1650 #ifdef CONFIG_SCSI_PROC_FS
1651 sg_proc_init();
1652 #endif /* CONFIG_SCSI_PROC_FS */
1653 return 0;
1654 }
1655 class_destroy(sg_sysfs_class);
1656 err_out:
1657 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1658 return rc;
1659 }
1660
1661 static void __exit
1662 exit_sg(void)
1663 {
1664 #ifdef CONFIG_SCSI_PROC_FS
1665 sg_proc_cleanup();
1666 #endif /* CONFIG_SCSI_PROC_FS */
1667 scsi_unregister_interface(&sg_interface);
1668 class_destroy(sg_sysfs_class);
1669 sg_sysfs_valid = 0;
1670 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1671 SG_MAX_DEVS);
1672 idr_destroy(&sg_index_idr);
1673 }
1674
1675 static int
1676 sg_start_req(Sg_request *srp, unsigned char *cmd)
1677 {
1678 int res;
1679 struct request *rq;
1680 struct scsi_request *req;
1681 Sg_fd *sfp = srp->parentfp;
1682 sg_io_hdr_t *hp = &srp->header;
1683 int dxfer_len = (int) hp->dxfer_len;
1684 int dxfer_dir = hp->dxfer_direction;
1685 unsigned int iov_count = hp->iovec_count;
1686 Sg_scatter_hold *req_schp = &srp->data;
1687 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1688 struct request_queue *q = sfp->parentdp->device->request_queue;
1689 struct rq_map_data *md, map_data;
1690 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1691 unsigned char *long_cmdp = NULL;
1692
1693 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1694 "sg_start_req: dxfer_len=%d\n",
1695 dxfer_len));
1696
1697 if (hp->cmd_len > BLK_MAX_CDB) {
1698 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1699 if (!long_cmdp)
1700 return -ENOMEM;
1701 }
1702
1703 /*
1704 * NOTE
1705 *
1706 * With scsi-mq enabled, there are a fixed number of preallocated
1707 * requests equal in number to shost->can_queue. If all of the
1708 * preallocated requests are already in use, then using GFP_ATOMIC with
1709 * blk_get_request() will return -EWOULDBLOCK, whereas using GFP_KERNEL
1710 * will cause blk_get_request() to sleep until an active command
1711 * completes, freeing up a request. Neither option is ideal, but
1712 * GFP_KERNEL is the better choice to prevent userspace from getting an
1713 * unexpected EWOULDBLOCK.
1714 *
1715 * With scsi-mq disabled, blk_get_request() with GFP_KERNEL usually
1716 * does not sleep except under memory pressure.
1717 */
1718 rq = blk_get_request(q, hp->dxfer_direction == SG_DXFER_TO_DEV ?
1719 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, GFP_KERNEL);
1720 if (IS_ERR(rq)) {
1721 kfree(long_cmdp);
1722 return PTR_ERR(rq);
1723 }
1724 req = scsi_req(rq);
1725
1726 if (hp->cmd_len > BLK_MAX_CDB)
1727 req->cmd = long_cmdp;
1728 memcpy(req->cmd, cmd, hp->cmd_len);
1729 req->cmd_len = hp->cmd_len;
1730
1731 srp->rq = rq;
1732 rq->end_io_data = srp;
1733 req->retries = SG_DEFAULT_RETRIES;
1734
1735 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1736 return 0;
1737
1738 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1739 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1740 !sfp->parentdp->device->host->unchecked_isa_dma &&
1741 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1742 md = NULL;
1743 else
1744 md = &map_data;
1745
1746 if (md) {
1747 mutex_lock(&sfp->f_mutex);
1748 if (dxfer_len <= rsv_schp->bufflen &&
1749 !sfp->res_in_use) {
1750 sfp->res_in_use = 1;
1751 sg_link_reserve(sfp, srp, dxfer_len);
1752 } else if (hp->flags & SG_FLAG_MMAP_IO) {
1753 res = -EBUSY; /* sfp->res_in_use == 1 */
1754 if (dxfer_len > rsv_schp->bufflen)
1755 res = -ENOMEM;
1756 mutex_unlock(&sfp->f_mutex);
1757 return res;
1758 } else {
1759 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1760 if (res) {
1761 mutex_unlock(&sfp->f_mutex);
1762 return res;
1763 }
1764 }
1765 mutex_unlock(&sfp->f_mutex);
1766
1767 md->pages = req_schp->pages;
1768 md->page_order = req_schp->page_order;
1769 md->nr_entries = req_schp->k_use_sg;
1770 md->offset = 0;
1771 md->null_mapped = hp->dxferp ? 0 : 1;
1772 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1773 md->from_user = 1;
1774 else
1775 md->from_user = 0;
1776 }
1777
1778 if (iov_count) {
1779 struct iovec *iov = NULL;
1780 struct iov_iter i;
1781
1782 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1783 if (res < 0)
1784 return res;
1785
1786 iov_iter_truncate(&i, hp->dxfer_len);
1787 if (!iov_iter_count(&i)) {
1788 kfree(iov);
1789 return -EINVAL;
1790 }
1791
1792 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
1793 kfree(iov);
1794 } else
1795 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1796 hp->dxfer_len, GFP_ATOMIC);
1797
1798 if (!res) {
1799 srp->bio = rq->bio;
1800
1801 if (!md) {
1802 req_schp->dio_in_use = 1;
1803 hp->info |= SG_INFO_DIRECT_IO;
1804 }
1805 }
1806 return res;
1807 }
1808
1809 static int
1810 sg_finish_rem_req(Sg_request *srp)
1811 {
1812 int ret = 0;
1813
1814 Sg_fd *sfp = srp->parentfp;
1815 Sg_scatter_hold *req_schp = &srp->data;
1816
1817 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1818 "sg_finish_rem_req: res_used=%d\n",
1819 (int) srp->res_used));
1820 if (srp->bio)
1821 ret = blk_rq_unmap_user(srp->bio);
1822
1823 if (srp->rq) {
1824 scsi_req_free_cmd(scsi_req(srp->rq));
1825 blk_put_request(srp->rq);
1826 }
1827
1828 if (srp->res_used)
1829 sg_unlink_reserve(sfp, srp);
1830 else
1831 sg_remove_scat(sfp, req_schp);
1832
1833 return ret;
1834 }
1835
1836 static int
1837 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1838 {
1839 int sg_bufflen = tablesize * sizeof(struct page *);
1840 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1841
1842 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1843 if (!schp->pages)
1844 return -ENOMEM;
1845 schp->sglist_len = sg_bufflen;
1846 return tablesize; /* number of scat_gath elements allocated */
1847 }
1848
1849 static int
1850 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1851 {
1852 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1853 int sg_tablesize = sfp->parentdp->sg_tablesize;
1854 int blk_size = buff_size, order;
1855 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1856 struct sg_device *sdp = sfp->parentdp;
1857
1858 if (blk_size < 0)
1859 return -EFAULT;
1860 if (0 == blk_size)
1861 ++blk_size; /* don't know why */
1862 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1863 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1864 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1865 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1866 buff_size, blk_size));
1867
1868 /* N.B. ret_sz carried into this block ... */
1869 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1870 if (mx_sc_elems < 0)
1871 return mx_sc_elems; /* most likely -ENOMEM */
1872
1873 num = scatter_elem_sz;
1874 if (unlikely(num != scatter_elem_sz_prev)) {
1875 if (num < PAGE_SIZE) {
1876 scatter_elem_sz = PAGE_SIZE;
1877 scatter_elem_sz_prev = PAGE_SIZE;
1878 } else
1879 scatter_elem_sz_prev = num;
1880 }
1881
1882 if (sdp->device->host->unchecked_isa_dma)
1883 gfp_mask |= GFP_DMA;
1884
1885 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1886 gfp_mask |= __GFP_ZERO;
1887
1888 order = get_order(num);
1889 retry:
1890 ret_sz = 1 << (PAGE_SHIFT + order);
1891
1892 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1893 k++, rem_sz -= ret_sz) {
1894
1895 num = (rem_sz > scatter_elem_sz_prev) ?
1896 scatter_elem_sz_prev : rem_sz;
1897
1898 schp->pages[k] = alloc_pages(gfp_mask, order);
1899 if (!schp->pages[k])
1900 goto out;
1901
1902 if (num == scatter_elem_sz_prev) {
1903 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1904 scatter_elem_sz = ret_sz;
1905 scatter_elem_sz_prev = ret_sz;
1906 }
1907 }
1908
1909 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1910 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1911 k, num, ret_sz));
1912 } /* end of for loop */
1913
1914 schp->page_order = order;
1915 schp->k_use_sg = k;
1916 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1917 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1918 k, rem_sz));
1919
1920 schp->bufflen = blk_size;
1921 if (rem_sz > 0) /* must have failed */
1922 return -ENOMEM;
1923 return 0;
1924 out:
1925 for (i = 0; i < k; i++)
1926 __free_pages(schp->pages[i], order);
1927
1928 if (--order >= 0)
1929 goto retry;
1930
1931 return -ENOMEM;
1932 }
1933
1934 static void
1935 sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
1936 {
1937 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1938 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1939 if (schp->pages && schp->sglist_len > 0) {
1940 if (!schp->dio_in_use) {
1941 int k;
1942
1943 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1944 SCSI_LOG_TIMEOUT(5,
1945 sg_printk(KERN_INFO, sfp->parentdp,
1946 "sg_remove_scat: k=%d, pg=0x%p\n",
1947 k, schp->pages[k]));
1948 __free_pages(schp->pages[k], schp->page_order);
1949 }
1950
1951 kfree(schp->pages);
1952 }
1953 }
1954 memset(schp, 0, sizeof (*schp));
1955 }
1956
1957 static int
1958 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1959 {
1960 Sg_scatter_hold *schp = &srp->data;
1961 int k, num;
1962
1963 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1964 "sg_read_oxfer: num_read_xfer=%d\n",
1965 num_read_xfer));
1966 if ((!outp) || (num_read_xfer <= 0))
1967 return 0;
1968
1969 num = 1 << (PAGE_SHIFT + schp->page_order);
1970 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1971 if (num > num_read_xfer) {
1972 if (__copy_to_user(outp, page_address(schp->pages[k]),
1973 num_read_xfer))
1974 return -EFAULT;
1975 break;
1976 } else {
1977 if (__copy_to_user(outp, page_address(schp->pages[k]),
1978 num))
1979 return -EFAULT;
1980 num_read_xfer -= num;
1981 if (num_read_xfer <= 0)
1982 break;
1983 outp += num;
1984 }
1985 }
1986
1987 return 0;
1988 }
1989
1990 static void
1991 sg_build_reserve(Sg_fd * sfp, int req_size)
1992 {
1993 Sg_scatter_hold *schp = &sfp->reserve;
1994
1995 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1996 "sg_build_reserve: req_size=%d\n", req_size));
1997 do {
1998 if (req_size < PAGE_SIZE)
1999 req_size = PAGE_SIZE;
2000 if (0 == sg_build_indirect(schp, sfp, req_size))
2001 return;
2002 else
2003 sg_remove_scat(sfp, schp);
2004 req_size >>= 1; /* divide by 2 */
2005 } while (req_size > (PAGE_SIZE / 2));
2006 }
2007
2008 static void
2009 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2010 {
2011 Sg_scatter_hold *req_schp = &srp->data;
2012 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2013 int k, num, rem;
2014
2015 srp->res_used = 1;
2016 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2017 "sg_link_reserve: size=%d\n", size));
2018 rem = size;
2019
2020 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2021 for (k = 0; k < rsv_schp->k_use_sg; k++) {
2022 if (rem <= num) {
2023 req_schp->k_use_sg = k + 1;
2024 req_schp->sglist_len = rsv_schp->sglist_len;
2025 req_schp->pages = rsv_schp->pages;
2026
2027 req_schp->bufflen = size;
2028 req_schp->page_order = rsv_schp->page_order;
2029 break;
2030 } else
2031 rem -= num;
2032 }
2033
2034 if (k >= rsv_schp->k_use_sg)
2035 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2036 "sg_link_reserve: BAD size\n"));
2037 }
2038
2039 static void
2040 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2041 {
2042 Sg_scatter_hold *req_schp = &srp->data;
2043
2044 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2045 "sg_unlink_reserve: req->k_use_sg=%d\n",
2046 (int) req_schp->k_use_sg));
2047 req_schp->k_use_sg = 0;
2048 req_schp->bufflen = 0;
2049 req_schp->pages = NULL;
2050 req_schp->page_order = 0;
2051 req_schp->sglist_len = 0;
2052 srp->res_used = 0;
2053 /* Called without mutex lock to avoid deadlock */
2054 sfp->res_in_use = 0;
2055 }
2056
2057 static Sg_request *
2058 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2059 {
2060 Sg_request *resp;
2061 unsigned long iflags;
2062
2063 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2064 list_for_each_entry(resp, &sfp->rq_list, entry) {
2065 /* look for requests that are ready + not SG_IO owned */
2066 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2067 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2068 resp->done = 2; /* guard against other readers */
2069 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2070 return resp;
2071 }
2072 }
2073 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2074 return NULL;
2075 }
2076
2077 /* always adds to end of list */
2078 static Sg_request *
2079 sg_add_request(Sg_fd * sfp)
2080 {
2081 int k;
2082 unsigned long iflags;
2083 Sg_request *rp = sfp->req_arr;
2084
2085 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2086 if (!list_empty(&sfp->rq_list)) {
2087 if (!sfp->cmd_q)
2088 goto out_unlock;
2089
2090 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2091 if (!rp->parentfp)
2092 break;
2093 }
2094 if (k >= SG_MAX_QUEUE)
2095 goto out_unlock;
2096 }
2097 memset(rp, 0, sizeof (Sg_request));
2098 rp->parentfp = sfp;
2099 rp->header.duration = jiffies_to_msecs(jiffies);
2100 list_add_tail(&rp->entry, &sfp->rq_list);
2101 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2102 return rp;
2103 out_unlock:
2104 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2105 return NULL;
2106 }
2107
2108 /* Return of 1 for found; 0 for not found */
2109 static int
2110 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2111 {
2112 unsigned long iflags;
2113 int res = 0;
2114
2115 if (!sfp || !srp || list_empty(&sfp->rq_list))
2116 return res;
2117 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2118 if (!list_empty(&srp->entry)) {
2119 list_del(&srp->entry);
2120 srp->parentfp = NULL;
2121 res = 1;
2122 }
2123 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2124 return res;
2125 }
2126
2127 static Sg_fd *
2128 sg_add_sfp(Sg_device * sdp)
2129 {
2130 Sg_fd *sfp;
2131 unsigned long iflags;
2132 int bufflen;
2133
2134 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2135 if (!sfp)
2136 return ERR_PTR(-ENOMEM);
2137
2138 init_waitqueue_head(&sfp->read_wait);
2139 rwlock_init(&sfp->rq_list_lock);
2140 INIT_LIST_HEAD(&sfp->rq_list);
2141 kref_init(&sfp->f_ref);
2142 mutex_init(&sfp->f_mutex);
2143 sfp->timeout = SG_DEFAULT_TIMEOUT;
2144 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2145 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2146 sfp->cmd_q = SG_DEF_COMMAND_Q;
2147 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2148 sfp->parentdp = sdp;
2149 write_lock_irqsave(&sdp->sfd_lock, iflags);
2150 if (atomic_read(&sdp->detaching)) {
2151 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2152 return ERR_PTR(-ENODEV);
2153 }
2154 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2155 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2156 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2157 "sg_add_sfp: sfp=0x%p\n", sfp));
2158 if (unlikely(sg_big_buff != def_reserved_size))
2159 sg_big_buff = def_reserved_size;
2160
2161 bufflen = min_t(int, sg_big_buff,
2162 max_sectors_bytes(sdp->device->request_queue));
2163 sg_build_reserve(sfp, bufflen);
2164 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2165 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2166 sfp->reserve.bufflen,
2167 sfp->reserve.k_use_sg));
2168
2169 kref_get(&sdp->d_ref);
2170 __module_get(THIS_MODULE);
2171 return sfp;
2172 }
2173
2174 static void
2175 sg_remove_sfp_usercontext(struct work_struct *work)
2176 {
2177 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2178 struct sg_device *sdp = sfp->parentdp;
2179 Sg_request *srp;
2180 unsigned long iflags;
2181
2182 /* Cleanup any responses which were never read(). */
2183 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2184 while (!list_empty(&sfp->rq_list)) {
2185 srp = list_first_entry(&sfp->rq_list, Sg_request, entry);
2186 sg_finish_rem_req(srp);
2187 list_del(&srp->entry);
2188 srp->parentfp = NULL;
2189 }
2190 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2191
2192 if (sfp->reserve.bufflen > 0) {
2193 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2194 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2195 (int) sfp->reserve.bufflen,
2196 (int) sfp->reserve.k_use_sg));
2197 sg_remove_scat(sfp, &sfp->reserve);
2198 }
2199
2200 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2201 "sg_remove_sfp: sfp=0x%p\n", sfp));
2202 kfree(sfp);
2203
2204 scsi_device_put(sdp->device);
2205 kref_put(&sdp->d_ref, sg_device_destroy);
2206 module_put(THIS_MODULE);
2207 }
2208
2209 static void
2210 sg_remove_sfp(struct kref *kref)
2211 {
2212 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2213 struct sg_device *sdp = sfp->parentdp;
2214 unsigned long iflags;
2215
2216 write_lock_irqsave(&sdp->sfd_lock, iflags);
2217 list_del(&sfp->sfd_siblings);
2218 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2219
2220 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2221 schedule_work(&sfp->ew.work);
2222 }
2223
2224 #ifdef CONFIG_SCSI_PROC_FS
2225 static int
2226 sg_idr_max_id(int id, void *p, void *data)
2227 {
2228 int *k = data;
2229
2230 if (*k < id)
2231 *k = id;
2232
2233 return 0;
2234 }
2235
2236 static int
2237 sg_last_dev(void)
2238 {
2239 int k = -1;
2240 unsigned long iflags;
2241
2242 read_lock_irqsave(&sg_index_lock, iflags);
2243 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2244 read_unlock_irqrestore(&sg_index_lock, iflags);
2245 return k + 1; /* origin 1 */
2246 }
2247 #endif
2248
2249 /* must be called with sg_index_lock held */
2250 static Sg_device *sg_lookup_dev(int dev)
2251 {
2252 return idr_find(&sg_index_idr, dev);
2253 }
2254
2255 static Sg_device *
2256 sg_get_dev(int dev)
2257 {
2258 struct sg_device *sdp;
2259 unsigned long flags;
2260
2261 read_lock_irqsave(&sg_index_lock, flags);
2262 sdp = sg_lookup_dev(dev);
2263 if (!sdp)
2264 sdp = ERR_PTR(-ENXIO);
2265 else if (atomic_read(&sdp->detaching)) {
2266 /* If sdp->detaching, then the refcount may already be 0, in
2267 * which case it would be a bug to do kref_get().
2268 */
2269 sdp = ERR_PTR(-ENODEV);
2270 } else
2271 kref_get(&sdp->d_ref);
2272 read_unlock_irqrestore(&sg_index_lock, flags);
2273
2274 return sdp;
2275 }
2276
2277 #ifdef CONFIG_SCSI_PROC_FS
2278
2279 static struct proc_dir_entry *sg_proc_sgp = NULL;
2280
2281 static char sg_proc_sg_dirname[] = "scsi/sg";
2282
2283 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2284
2285 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2286 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2287 size_t count, loff_t *off);
2288 static const struct file_operations adio_fops = {
2289 .owner = THIS_MODULE,
2290 .open = sg_proc_single_open_adio,
2291 .read = seq_read,
2292 .llseek = seq_lseek,
2293 .write = sg_proc_write_adio,
2294 .release = single_release,
2295 };
2296
2297 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2298 static ssize_t sg_proc_write_dressz(struct file *filp,
2299 const char __user *buffer, size_t count, loff_t *off);
2300 static const struct file_operations dressz_fops = {
2301 .owner = THIS_MODULE,
2302 .open = sg_proc_single_open_dressz,
2303 .read = seq_read,
2304 .llseek = seq_lseek,
2305 .write = sg_proc_write_dressz,
2306 .release = single_release,
2307 };
2308
2309 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2310 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2311 static const struct file_operations version_fops = {
2312 .owner = THIS_MODULE,
2313 .open = sg_proc_single_open_version,
2314 .read = seq_read,
2315 .llseek = seq_lseek,
2316 .release = single_release,
2317 };
2318
2319 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2320 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2321 static const struct file_operations devhdr_fops = {
2322 .owner = THIS_MODULE,
2323 .open = sg_proc_single_open_devhdr,
2324 .read = seq_read,
2325 .llseek = seq_lseek,
2326 .release = single_release,
2327 };
2328
2329 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2330 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2331 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2332 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2333 static void dev_seq_stop(struct seq_file *s, void *v);
2334 static const struct file_operations dev_fops = {
2335 .owner = THIS_MODULE,
2336 .open = sg_proc_open_dev,
2337 .read = seq_read,
2338 .llseek = seq_lseek,
2339 .release = seq_release,
2340 };
2341 static const struct seq_operations dev_seq_ops = {
2342 .start = dev_seq_start,
2343 .next = dev_seq_next,
2344 .stop = dev_seq_stop,
2345 .show = sg_proc_seq_show_dev,
2346 };
2347
2348 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2349 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2350 static const struct file_operations devstrs_fops = {
2351 .owner = THIS_MODULE,
2352 .open = sg_proc_open_devstrs,
2353 .read = seq_read,
2354 .llseek = seq_lseek,
2355 .release = seq_release,
2356 };
2357 static const struct seq_operations devstrs_seq_ops = {
2358 .start = dev_seq_start,
2359 .next = dev_seq_next,
2360 .stop = dev_seq_stop,
2361 .show = sg_proc_seq_show_devstrs,
2362 };
2363
2364 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2365 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2366 static const struct file_operations debug_fops = {
2367 .owner = THIS_MODULE,
2368 .open = sg_proc_open_debug,
2369 .read = seq_read,
2370 .llseek = seq_lseek,
2371 .release = seq_release,
2372 };
2373 static const struct seq_operations debug_seq_ops = {
2374 .start = dev_seq_start,
2375 .next = dev_seq_next,
2376 .stop = dev_seq_stop,
2377 .show = sg_proc_seq_show_debug,
2378 };
2379
2380
2381 struct sg_proc_leaf {
2382 const char * name;
2383 const struct file_operations * fops;
2384 };
2385
2386 static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
2387 {"allow_dio", &adio_fops},
2388 {"debug", &debug_fops},
2389 {"def_reserved_size", &dressz_fops},
2390 {"device_hdr", &devhdr_fops},
2391 {"devices", &dev_fops},
2392 {"device_strs", &devstrs_fops},
2393 {"version", &version_fops}
2394 };
2395
2396 static int
2397 sg_proc_init(void)
2398 {
2399 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2400 int k;
2401
2402 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2403 if (!sg_proc_sgp)
2404 return 1;
2405 for (k = 0; k < num_leaves; ++k) {
2406 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
2407 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2408 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2409 }
2410 return 0;
2411 }
2412
2413 static void
2414 sg_proc_cleanup(void)
2415 {
2416 int k;
2417 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2418
2419 if (!sg_proc_sgp)
2420 return;
2421 for (k = 0; k < num_leaves; ++k)
2422 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2423 remove_proc_entry(sg_proc_sg_dirname, NULL);
2424 }
2425
2426
2427 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2428 {
2429 seq_printf(s, "%d\n", *((int *)s->private));
2430 return 0;
2431 }
2432
2433 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2434 {
2435 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2436 }
2437
2438 static ssize_t
2439 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2440 size_t count, loff_t *off)
2441 {
2442 int err;
2443 unsigned long num;
2444
2445 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2446 return -EACCES;
2447 err = kstrtoul_from_user(buffer, count, 0, &num);
2448 if (err)
2449 return err;
2450 sg_allow_dio = num ? 1 : 0;
2451 return count;
2452 }
2453
2454 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2455 {
2456 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2457 }
2458
2459 static ssize_t
2460 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2461 size_t count, loff_t *off)
2462 {
2463 int err;
2464 unsigned long k = ULONG_MAX;
2465
2466 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2467 return -EACCES;
2468
2469 err = kstrtoul_from_user(buffer, count, 0, &k);
2470 if (err)
2471 return err;
2472 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2473 sg_big_buff = k;
2474 return count;
2475 }
2476 return -ERANGE;
2477 }
2478
2479 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2480 {
2481 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2482 sg_version_date);
2483 return 0;
2484 }
2485
2486 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2487 {
2488 return single_open(file, sg_proc_seq_show_version, NULL);
2489 }
2490
2491 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2492 {
2493 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
2494 return 0;
2495 }
2496
2497 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2498 {
2499 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2500 }
2501
2502 struct sg_proc_deviter {
2503 loff_t index;
2504 size_t max;
2505 };
2506
2507 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2508 {
2509 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2510
2511 s->private = it;
2512 if (! it)
2513 return NULL;
2514
2515 it->index = *pos;
2516 it->max = sg_last_dev();
2517 if (it->index >= it->max)
2518 return NULL;
2519 return it;
2520 }
2521
2522 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2523 {
2524 struct sg_proc_deviter * it = s->private;
2525
2526 *pos = ++it->index;
2527 return (it->index < it->max) ? it : NULL;
2528 }
2529
2530 static void dev_seq_stop(struct seq_file *s, void *v)
2531 {
2532 kfree(s->private);
2533 }
2534
2535 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2536 {
2537 return seq_open(file, &dev_seq_ops);
2538 }
2539
2540 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2541 {
2542 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2543 Sg_device *sdp;
2544 struct scsi_device *scsidp;
2545 unsigned long iflags;
2546
2547 read_lock_irqsave(&sg_index_lock, iflags);
2548 sdp = it ? sg_lookup_dev(it->index) : NULL;
2549 if ((NULL == sdp) || (NULL == sdp->device) ||
2550 (atomic_read(&sdp->detaching)))
2551 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2552 else {
2553 scsidp = sdp->device;
2554 seq_printf(s, "%d\t%d\t%d\t%llu\t%d\t%d\t%d\t%d\t%d\n",
2555 scsidp->host->host_no, scsidp->channel,
2556 scsidp->id, scsidp->lun, (int) scsidp->type,
2557 1,
2558 (int) scsidp->queue_depth,
2559 (int) atomic_read(&scsidp->device_busy),
2560 (int) scsi_device_online(scsidp));
2561 }
2562 read_unlock_irqrestore(&sg_index_lock, iflags);
2563 return 0;
2564 }
2565
2566 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2567 {
2568 return seq_open(file, &devstrs_seq_ops);
2569 }
2570
2571 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2572 {
2573 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2574 Sg_device *sdp;
2575 struct scsi_device *scsidp;
2576 unsigned long iflags;
2577
2578 read_lock_irqsave(&sg_index_lock, iflags);
2579 sdp = it ? sg_lookup_dev(it->index) : NULL;
2580 scsidp = sdp ? sdp->device : NULL;
2581 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
2582 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2583 scsidp->vendor, scsidp->model, scsidp->rev);
2584 else
2585 seq_puts(s, "<no active device>\n");
2586 read_unlock_irqrestore(&sg_index_lock, iflags);
2587 return 0;
2588 }
2589
2590 /* must be called while holding sg_index_lock */
2591 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2592 {
2593 int k, new_interface, blen, usg;
2594 Sg_request *srp;
2595 Sg_fd *fp;
2596 const sg_io_hdr_t *hp;
2597 const char * cp;
2598 unsigned int ms;
2599
2600 k = 0;
2601 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2602 k++;
2603 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2604 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2605 "(res)sgat=%d low_dma=%d\n", k,
2606 jiffies_to_msecs(fp->timeout),
2607 fp->reserve.bufflen,
2608 (int) fp->reserve.k_use_sg,
2609 (int) sdp->device->host->unchecked_isa_dma);
2610 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2611 (int) fp->cmd_q, (int) fp->force_packid,
2612 (int) fp->keep_orphan);
2613 list_for_each_entry(srp, &fp->rq_list, entry) {
2614 hp = &srp->header;
2615 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2616 if (srp->res_used) {
2617 if (new_interface &&
2618 (SG_FLAG_MMAP_IO & hp->flags))
2619 cp = " mmap>> ";
2620 else
2621 cp = " rb>> ";
2622 } else {
2623 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2624 cp = " dio>> ";
2625 else
2626 cp = " ";
2627 }
2628 seq_puts(s, cp);
2629 blen = srp->data.bufflen;
2630 usg = srp->data.k_use_sg;
2631 seq_puts(s, srp->done ?
2632 ((1 == srp->done) ? "rcv:" : "fin:")
2633 : "act:");
2634 seq_printf(s, " id=%d blen=%d",
2635 srp->header.pack_id, blen);
2636 if (srp->done)
2637 seq_printf(s, " dur=%d", hp->duration);
2638 else {
2639 ms = jiffies_to_msecs(jiffies);
2640 seq_printf(s, " t_o/elap=%d/%d",
2641 (new_interface ? hp->timeout :
2642 jiffies_to_msecs(fp->timeout)),
2643 (ms > hp->duration ? ms - hp->duration : 0));
2644 }
2645 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2646 (int) srp->data.cmd_opcode);
2647 }
2648 if (list_empty(&fp->rq_list))
2649 seq_puts(s, " No requests active\n");
2650 read_unlock(&fp->rq_list_lock);
2651 }
2652 }
2653
2654 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2655 {
2656 return seq_open(file, &debug_seq_ops);
2657 }
2658
2659 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2660 {
2661 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2662 Sg_device *sdp;
2663 unsigned long iflags;
2664
2665 if (it && (0 == it->index))
2666 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2667 (int)it->max, sg_big_buff);
2668
2669 read_lock_irqsave(&sg_index_lock, iflags);
2670 sdp = it ? sg_lookup_dev(it->index) : NULL;
2671 if (NULL == sdp)
2672 goto skip;
2673 read_lock(&sdp->sfd_lock);
2674 if (!list_empty(&sdp->sfds)) {
2675 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2676 if (atomic_read(&sdp->detaching))
2677 seq_puts(s, "detaching pending close ");
2678 else if (sdp->device) {
2679 struct scsi_device *scsidp = sdp->device;
2680
2681 seq_printf(s, "%d:%d:%d:%llu em=%d",
2682 scsidp->host->host_no,
2683 scsidp->channel, scsidp->id,
2684 scsidp->lun,
2685 scsidp->host->hostt->emulated);
2686 }
2687 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2688 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
2689 sg_proc_debug_helper(s, sdp);
2690 }
2691 read_unlock(&sdp->sfd_lock);
2692 skip:
2693 read_unlock_irqrestore(&sg_index_lock, iflags);
2694 return 0;
2695 }
2696
2697 #endif /* CONFIG_SCSI_PROC_FS */
2698
2699 module_init(init_sg);
2700 module_exit(exit_sg);
Ubuntu Artful kernel mirror