sys/cam/scsi/scsi_pass.c

   1 /*-
   2  * Copyright (c) 1997, 1998, 2000 Justin T. Gibbs.
   3  * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer,
  11  *    without modification, immediately at the beginning of the file.
  12  * 2. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/kernel.h>
  34 #include <sys/types.h>
  35 #include <sys/bio.h>
  36 #include <sys/malloc.h>
  37 #include <sys/fcntl.h>
  38 #include <sys/conf.h>
  39 #include <sys/errno.h>
  40 #include <sys/devicestat.h>
  41 #include <sys/proc.h>
  42
  43 #include <cam/cam.h>
  44 #include <cam/cam_ccb.h>
  45 #include <cam/cam_periph.h>
  46 #include <cam/cam_queue.h>
  47 #include <cam/cam_xpt_periph.h>
  48 #include <cam/cam_debug.h>
  49 #include <cam/cam_sim.h>
  50
  51 #include <cam/scsi/scsi_all.h>
  52 #include <cam/scsi/scsi_pass.h>
  53
  54 typedef enum {
  55         PASS_FLAG_OPEN                  = 0x01,
  56         PASS_FLAG_LOCKED                = 0x02,
  57         PASS_FLAG_INVALID               = 0x04
  58 } pass_flags;
  59
  60 typedef enum {
  61         PASS_STATE_NORMAL
  62 } pass_state;
  63
  64 typedef enum {
  65         PASS_CCB_BUFFER_IO,
  66         PASS_CCB_WAITING
  67 } pass_ccb_types;
  68
  69 #define ccb_type        ppriv_field0
  70 #define ccb_bp          ppriv_ptr1
  71
  72 struct pass_softc {
  73         pass_state              state;
  74         pass_flags              flags;
  75         u_int8_t                pd_type;
  76         union ccb               saved_ccb;
  77         struct devstat          *device_stats;
  78         struct cdev *dev;
  79 };
  80
  81
  82 static  d_open_t        passopen;
  83 static  d_close_t       passclose;
  84 static  d_ioctl_t       passioctl;
  85
  86 static  periph_init_t   passinit;
  87 static  periph_ctor_t   passregister;
  88 static  periph_oninv_t  passoninvalidate;
  89 static  periph_dtor_t   passcleanup;
  90 static  periph_start_t  passstart;
  91 static  void            passasync(void *callback_arg, u_int32_t code,
  92                                   struct cam_path *path, void *arg);
  93 static  void            passdone(struct cam_periph *periph,
  94                                  union ccb *done_ccb);
  95 static  int             passerror(union ccb *ccb, u_int32_t cam_flags,
  96                                   u_int32_t sense_flags);
  97 static  int             passsendccb(struct cam_periph *periph, union ccb *ccb,
  98                                     union ccb *inccb);
  99
 100 static struct periph_driver passdriver =
 101 {
 102         passinit, "pass",
 103         TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0
 104 };
 105
 106 PERIPHDRIVER_DECLARE(pass, passdriver);
 107
 108 static struct cdevsw pass_cdevsw = {
 109         .d_version =    D_VERSION,
 110         .d_flags =      0,
 111         .d_open =       passopen,
 112         .d_close =      passclose,
 113         .d_ioctl =      passioctl,
 114         .d_name =       "pass",
 115 };
 116
 117 static void
 118 passinit(void)
 119 {
 120         cam_status status;
 121
 122         /*
 123          * Install a global async callback.  This callback will
 124          * receive async callbacks like "new device found".
 125          */
 126         status = xpt_register_async(AC_FOUND_DEVICE, passasync, NULL, NULL);
 127
 128         if (status != CAM_REQ_CMP) {
 129                 printf("pass: Failed to attach master async callback "
 130                        "due to status 0x%x!\n", status);
 131         }
 132
 133 }
 134
 135 static void
 136 passoninvalidate(struct cam_periph *periph)
 137 {
 138         struct pass_softc *softc;
 139
 140         softc = (struct pass_softc *)periph->softc;
 141
 142         /*
 143          * De-register any async callbacks.
 144          */
 145         xpt_register_async(0, passasync, periph, periph->path);
 146
 147         softc->flags |= PASS_FLAG_INVALID;
 148
 149         /*
 150          * XXX Return all queued I/O with ENXIO.
 151          * XXX Handle any transactions queued to the card
 152          *     with XPT_ABORT_CCB.
 153          */
 154
 155         if (bootverbose) {
 156                 xpt_print(periph->path, "lost device\n");
 157         }
 158
 159 }
 160
 161 static void
 162 passcleanup(struct cam_periph *periph)
 163 {
 164         struct pass_softc *softc;
 165
 166         softc = (struct pass_softc *)periph->softc;
 167
 168         if (bootverbose)
 169                 xpt_print(periph->path, "removing device entry\n");
 170         devstat_remove_entry(softc->device_stats);
 171         cam_periph_unlock(periph);
 172         /*
 173          * passcleanup() is indirectly a d_close method via passclose,
 174          * so using destroy_dev(9) directly can result in deadlock.
 175          */
 176         destroy_dev_sched(softc->dev);
 177         cam_periph_lock(periph);
 178         free(softc, M_DEVBUF);
 179 }
 180
 181 static void
 182 passasync(void *callback_arg, u_int32_t code,
 183           struct cam_path *path, void *arg)
 184 {
 185         struct cam_periph *periph;
 186
 187         periph = (struct cam_periph *)callback_arg;
 188
 189         switch (code) {
 190         case AC_FOUND_DEVICE:
 191         {
 192                 struct ccb_getdev *cgd;
 193                 cam_status status;
 194
 195                 cgd = (struct ccb_getdev *)arg;
 196                 if (cgd == NULL)
 197                         break;
 198
 199                 /*
 200                  * Allocate a peripheral instance for
 201                  * this device and start the probe
 202                  * process.
 203                  */
 204                 status = cam_periph_alloc(passregister, passoninvalidate,
 205                                           passcleanup, passstart, "pass",
 206                                           CAM_PERIPH_BIO, cgd->ccb_h.path,
 207                                           passasync, AC_FOUND_DEVICE, cgd);
 208
 209                 if (status != CAM_REQ_CMP
 210                  && status != CAM_REQ_INPROG) {
 211                         const struct cam_status_entry *entry;
 212
 213                         entry = cam_fetch_status_entry(status);
 214
 215                         printf("passasync: Unable to attach new device "
 216                                "due to status %#x: %s\n", status, entry ?
 217                                entry->status_text : "Unknown");
 218                 }
 219
 220                 break;
 221         }
 222         default:
 223                 cam_periph_async(periph, code, path, arg);
 224                 break;
 225         }
 226 }
 227
 228 static cam_status
 229 passregister(struct cam_periph *periph, void *arg)
 230 {
 231         struct pass_softc *softc;
 232         struct ccb_getdev *cgd;
 233         struct ccb_pathinq cpi;
 234         int    no_tags;
 235
 236         cgd = (struct ccb_getdev *)arg;
 237         if (periph == NULL) {
 238                 printf("passregister: periph was NULL!!\n");
 239                 return(CAM_REQ_CMP_ERR);
 240         }
 241
 242         if (cgd == NULL) {
 243                 printf("passregister: no getdev CCB, can't register device\n");
 244                 return(CAM_REQ_CMP_ERR);
 245         }
 246
 247         softc = (struct pass_softc *)malloc(sizeof(*softc),
 248                                             M_DEVBUF, M_NOWAIT);
 249
 250         if (softc == NULL) {
 251                 printf("passregister: Unable to probe new device. "
 252                        "Unable to allocate softc\n");
 253                 return(CAM_REQ_CMP_ERR);
 254         }
 255
 256         bzero(softc, sizeof(*softc));
 257         softc->state = PASS_STATE_NORMAL;
 258         if (cgd->protocol == PROTO_SCSI || cgd->protocol == PROTO_ATAPI)
 259                 softc->pd_type = SID_TYPE(&cgd->inq_data);
 260         else if (cgd->protocol == PROTO_SATAPM)
 261                 softc->pd_type = T_ENCLOSURE;
 262         else
 263                 softc->pd_type = T_DIRECT;
 264
 265         periph->softc = softc;
 266
 267         bzero(&cpi, sizeof(cpi));
 268         xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 269         cpi.ccb_h.func_code = XPT_PATH_INQ;
 270         xpt_action((union ccb *)&cpi);
 271
 272         /*
 273          * We pass in 0 for a blocksize, since we don't
 274          * know what the blocksize of this device is, if
 275          * it even has a blocksize.
 276          */
 277         mtx_unlock(periph->sim->mtx);
 278         no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0;
 279         softc->device_stats = devstat_new_entry("pass",
 280                           periph->unit_number, 0,
 281                           DEVSTAT_NO_BLOCKSIZE
 282                           | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0),
 283                           softc->pd_type |
 284                           XPORT_DEVSTAT_TYPE(cpi.transport) |
 285                           DEVSTAT_TYPE_PASS,
 286                           DEVSTAT_PRIORITY_PASS);
 287
 288         /* Register the device */
 289         softc->dev = make_dev(&pass_cdevsw, periph->unit_number,
 290                               UID_ROOT, GID_OPERATOR, 0600, "%s%d",
 291                               periph->periph_name, periph->unit_number);
 292         mtx_lock(periph->sim->mtx);
 293         softc->dev->si_drv1 = periph;
 294
 295         /*
 296          * Add an async callback so that we get
 297          * notified if this device goes away.
 298          */
 299         xpt_register_async(AC_LOST_DEVICE, passasync, periph, periph->path);
 300
 301         if (bootverbose)
 302                 xpt_announce_periph(periph, NULL);
 303
 304         return(CAM_REQ_CMP);
 305 }
 306
 307 static int
 308 passopen(struct cdev *dev, int flags, int fmt, struct thread *td)
 309 {
 310         struct cam_periph *periph;
 311         struct pass_softc *softc;
 312         int error;
 313
 314         periph = (struct cam_periph *)dev->si_drv1;
 315         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
 316                 return (ENXIO);
 317
 318         cam_periph_lock(periph);
 319
 320         softc = (struct pass_softc *)periph->softc;
 321
 322         if (softc->flags & PASS_FLAG_INVALID) {
 323                 cam_periph_unlock(periph);
 324                 cam_periph_release(periph);
 325                 return(ENXIO);
 326         }
 327
 328         /*
 329          * Don't allow access when we're running at a high securelevel.
 330          */
 331         error = securelevel_gt(td->td_ucred, 1);
 332         if (error) {
 333                 cam_periph_unlock(periph);
 334                 cam_periph_release(periph);
 335                 return(error);
 336         }
 337
 338         /*
 339          * Only allow read-write access.
 340          */
 341         if (((flags & FWRITE) == 0) || ((flags & FREAD) == 0)) {
 342                 cam_periph_unlock(periph);
 343                 cam_periph_release(periph);
 344                 return(EPERM);
 345         }
 346
 347         /*
 348          * We don't allow nonblocking access.
 349          */
 350         if ((flags & O_NONBLOCK) != 0) {
 351                 xpt_print(periph->path, "can't do nonblocking access\n");
 352                 cam_periph_unlock(periph);
 353                 cam_periph_release(periph);
 354                 return(EINVAL);
 355         }
 356
 357         if ((softc->flags & PASS_FLAG_OPEN) == 0) {
 358                 softc->flags |= PASS_FLAG_OPEN;
 359                 cam_periph_unlock(periph);
 360         } else {
 361                 /* Device closes aren't symmertical, so fix up the refcount */
 362                 cam_periph_unlock(periph);
 363                 cam_periph_release(periph);
 364         }
 365
 366         return (error);
 367 }
 368
 369 static int
 370 passclose(struct cdev *dev, int flag, int fmt, struct thread *td)
 371 {
 372         struct  cam_periph *periph;
 373         struct  pass_softc *softc;
 374
 375         periph = (struct cam_periph *)dev->si_drv1;
 376         if (periph == NULL)
 377                 return (ENXIO);
 378
 379         cam_periph_lock(periph);
 380
 381         softc = (struct pass_softc *)periph->softc;
 382         softc->flags &= ~PASS_FLAG_OPEN;
 383
 384         cam_periph_unlock(periph);
 385         cam_periph_release(periph);
 386
 387         return (0);
 388 }
 389
 390 static void
 391 passstart(struct cam_periph *periph, union ccb *start_ccb)
 392 {
 393         struct pass_softc *softc;
 394
 395         softc = (struct pass_softc *)periph->softc;
 396
 397         switch (softc->state) {
 398         case PASS_STATE_NORMAL:
 399                 start_ccb->ccb_h.ccb_type = PASS_CCB_WAITING;
 400                 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
 401                                   periph_links.sle);
 402                 periph->immediate_priority = CAM_PRIORITY_NONE;
 403                 wakeup(&periph->ccb_list);
 404                 break;
 405         }
 406 }
 407
 408 static void
 409 passdone(struct cam_periph *periph, union ccb *done_ccb)
 410 {
 411         struct pass_softc *softc;
 412         struct ccb_scsiio *csio;
 413
 414         softc = (struct pass_softc *)periph->softc;
 415         csio = &done_ccb->csio;
 416         switch (csio->ccb_h.ccb_type) {
 417         case PASS_CCB_WAITING:
 418                 /* Caller will release the CCB */
 419                 wakeup(&done_ccb->ccb_h.cbfcnp);
 420                 return;
 421         }
 422         xpt_release_ccb(done_ccb);
 423 }
 424
 425 static int
 426 passioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
 427 {
 428         struct  cam_periph *periph;
 429         struct  pass_softc *softc;
 430         int     error;
 431         uint32_t priority;
 432
 433         periph = (struct cam_periph *)dev->si_drv1;
 434         if (periph == NULL)
 435                 return(ENXIO);
 436
 437         cam_periph_lock(periph);
 438         softc = (struct pass_softc *)periph->softc;
 439
 440         error = 0;
 441
 442         switch (cmd) {
 443
 444         case CAMIOCOMMAND:
 445         {
 446                 union ccb *inccb;
 447                 union ccb *ccb;
 448                 int ccb_malloced;
 449
 450                 inccb = (union ccb *)addr;
 451
 452                 /*
 453                  * Some CCB types, like scan bus and scan lun can only go
 454                  * through the transport layer device.
 455                  */
 456                 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
 457                         xpt_print(periph->path, "CCB function code %#x is "
 458                             "restricted to the XPT device\n",
 459                             inccb->ccb_h.func_code);
 460                         error = ENODEV;
 461                         break;
 462                 }
 463
 464                 /* Compatibility for RL/priority-unaware code. */
 465                 priority = inccb->ccb_h.pinfo.priority;
 466                 if (priority < CAM_RL_TO_PRIORITY(CAM_RL_NORMAL))
 467                     priority += CAM_RL_TO_PRIORITY(CAM_RL_NORMAL);
 468
 469                 /*
 470                  * Non-immediate CCBs need a CCB from the per-device pool
 471                  * of CCBs, which is scheduled by the transport layer.
 472                  * Immediate CCBs and user-supplied CCBs should just be
 473                  * malloced.
 474                  */
 475                 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
 476                  && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
 477                         ccb = cam_periph_getccb(periph, priority);
 478                         ccb_malloced = 0;
 479                 } else {
 480                         ccb = xpt_alloc_ccb_nowait();
 481
 482                         if (ccb != NULL)
 483                                 xpt_setup_ccb(&ccb->ccb_h, periph->path,
 484                                               priority);
 485                         ccb_malloced = 1;
 486                 }
 487
 488                 if (ccb == NULL) {
 489                         xpt_print(periph->path, "unable to allocate CCB\n");
 490                         error = ENOMEM;
 491                         break;
 492                 }
 493
 494                 error = passsendccb(periph, ccb, inccb);
 495
 496                 if (ccb_malloced)
 497                         xpt_free_ccb(ccb);
 498                 else
 499                         xpt_release_ccb(ccb);
 500
 501                 break;
 502         }
 503         default:
 504                 error = cam_periph_ioctl(periph, cmd, addr, passerror);
 505                 break;
 506         }
 507
 508         cam_periph_unlock(periph);
 509         return(error);
 510 }
 511
 512 /*
 513  * Generally, "ccb" should be the CCB supplied by the kernel.  "inccb"
 514  * should be the CCB that is copied in from the user.
 515  */
 516 static int
 517 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
 518 {
 519         struct pass_softc *softc;
 520         struct cam_periph_map_info mapinfo;
 521         int error, need_unmap;
 522
 523         softc = (struct pass_softc *)periph->softc;
 524
 525         need_unmap = 0;
 526
 527         /*
 528          * There are some fields in the CCB header that need to be
 529          * preserved, the rest we get from the user.
 530          */
 531         xpt_merge_ccb(ccb, inccb);
 532
 533         /*
 534          * There's no way for the user to have a completion
 535          * function, so we put our own completion function in here.
 536          */
 537         ccb->ccb_h.cbfcnp = passdone;
 538
 539         /*
 540          * We only attempt to map the user memory into kernel space
 541          * if they haven't passed in a physical memory pointer,
 542          * and if there is actually an I/O operation to perform.
 543          * Right now cam_periph_mapmem() only supports SCSI and device
 544          * match CCBs.  For the SCSI CCBs, we only pass the CCB in if
 545          * there's actually data to map.  cam_periph_mapmem() will do the
 546          * right thing, even if there isn't data to map, but since CCBs
 547          * without data are a reasonably common occurance (e.g. test unit
 548          * ready), it will save a few cycles if we check for it here.
 549          */
 550         if (((ccb->ccb_h.flags & CAM_DATA_PHYS) == 0)
 551          && (((ccb->ccb_h.func_code == XPT_SCSI_IO ||
 552                ccb->ccb_h.func_code == XPT_ATA_IO)
 553             && ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE))
 554           || (ccb->ccb_h.func_code == XPT_DEV_MATCH))) {
 555
 556                 bzero(&mapinfo, sizeof(mapinfo));
 557
 558                 /*
 559                  * cam_periph_mapmem calls into proc and vm functions that can
 560                  * sleep as well as trigger I/O, so we can't hold the lock.
 561                  * Dropping it here is reasonably safe.
 562                  */
 563                 cam_periph_unlock(periph);
 564                 error = cam_periph_mapmem(ccb, &mapinfo);
 565                 cam_periph_lock(periph);
 566
 567                 /*
 568                  * cam_periph_mapmem returned an error, we can't continue.
 569                  * Return the error to the user.
 570                  */
 571                 if (error)
 572                         return(error);
 573
 574                 /*
 575                  * We successfully mapped the memory in, so we need to
 576                  * unmap it when the transaction is done.
 577                  */
 578                 need_unmap = 1;
 579         }
 580
 581         /*
 582          * If the user wants us to perform any error recovery, then honor
 583          * that request.  Otherwise, it's up to the user to perform any
 584          * error recovery.
 585          */
 586         cam_periph_runccb(ccb,
 587             (ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ? passerror : NULL,
 588             /* cam_flags */ CAM_RETRY_SELTO, /* sense_flags */SF_RETRY_UA,
 589             softc->device_stats);
 590
 591         if (need_unmap != 0)
 592                 cam_periph_unmapmem(ccb, &mapinfo);
 593
 594         ccb->ccb_h.cbfcnp = NULL;
 595         ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
 596         bcopy(ccb, inccb, sizeof(union ccb));
 597
 598         return(0);
 599 }
 600
 601 static int
 602 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
 603 {
 604         struct cam_periph *periph;
 605         struct pass_softc *softc;
 606
 607         periph = xpt_path_periph(ccb->ccb_h.path);
 608         softc = (struct pass_softc *)periph->softc;
 609
 610         return(cam_periph_error(ccb, cam_flags, sense_flags,
 611                                  &softc->saved_ccb));
 612 }