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