sys/cam/cam_periph.c

   1 /*-
   2  * Common functions for CAM "type" (peripheral) drivers.
   3  *
   4  * Copyright (c) 1997, 1998 Justin T. Gibbs.
   5  * Copyright (c) 1997, 1998, 1999, 2000 Kenneth D. Merry.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions, and the following disclaimer,
  13  *    without modification, immediately at the beginning of the file.
  14  * 2. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/types.h>
  36 #include <sys/malloc.h>
  37 #include <sys/kernel.h>
  38 #include <sys/bio.h>
  39 #include <sys/lock.h>
  40 #include <sys/mutex.h>
  41 #include <sys/buf.h>
  42 #include <sys/proc.h>
  43 #include <sys/devicestat.h>
  44 #include <sys/bus.h>
  45 #include <sys/sbuf.h>
  46 #include <vm/vm.h>
  47 #include <vm/vm_extern.h>
  48
  49 #include <cam/cam.h>
  50 #include <cam/cam_ccb.h>
  51 #include <cam/cam_queue.h>
  52 #include <cam/cam_xpt_periph.h>
  53 #include <cam/cam_periph.h>
  54 #include <cam/cam_debug.h>
  55 #include <cam/cam_sim.h>
  56
  57 #include <cam/scsi/scsi_all.h>
  58 #include <cam/scsi/scsi_message.h>
  59 #include <cam/scsi/scsi_pass.h>
  60
  61 static  u_int           camperiphnextunit(struct periph_driver *p_drv,
  62                                           u_int newunit, int wired,
  63                                           path_id_t pathid, target_id_t target,
  64                                           lun_id_t lun);
  65 static  u_int           camperiphunit(struct periph_driver *p_drv,
  66                                       path_id_t pathid, target_id_t target,
  67                                       lun_id_t lun);
  68 static  void            camperiphdone(struct cam_periph *periph,
  69                                         union ccb *done_ccb);
  70 static  void            camperiphfree(struct cam_periph *periph);
  71 static int              camperiphscsistatuserror(union ccb *ccb,
  72                                                 union ccb **orig_ccb,
  73                                                  cam_flags camflags,
  74                                                  u_int32_t sense_flags,
  75                                                  int *openings,
  76                                                  u_int32_t *relsim_flags,
  77                                                  u_int32_t *timeout,
  78                                                  int *print,
  79                                                  const char **action_string);
  80 static  int             camperiphscsisenseerror(union ccb *ccb,
  81                                                 union ccb **orig_ccb,
  82                                                 cam_flags camflags,
  83                                                 u_int32_t sense_flags,
  84                                                 int *openings,
  85                                                 u_int32_t *relsim_flags,
  86                                                 u_int32_t *timeout,
  87                                                 int *print,
  88                                                 const char **action_string);
  89
  90 static int nperiph_drivers;
  91 static int initialized = 0;
  92 struct periph_driver **periph_drivers;
  93
  94 static MALLOC_DEFINE(M_CAMPERIPH, "CAM periph", "CAM peripheral buffers");
  95
  96 static int periph_selto_delay = 1000;
  97 TUNABLE_INT("kern.cam.periph_selto_delay", &periph_selto_delay);
  98 static int periph_noresrc_delay = 500;
  99 TUNABLE_INT("kern.cam.periph_noresrc_delay", &periph_noresrc_delay);
 100 static int periph_busy_delay = 500;
 101 TUNABLE_INT("kern.cam.periph_busy_delay", &periph_busy_delay);
 102
 103
 104 void
 105 periphdriver_register(void *data)
 106 {
 107         struct periph_driver *drv = (struct periph_driver *)data;
 108         struct periph_driver **newdrivers, **old;
 109         int ndrivers;
 110
 111         ndrivers = nperiph_drivers + 2;
 112         newdrivers = malloc(sizeof(*newdrivers) * ndrivers, M_CAMPERIPH,
 113                             M_WAITOK);
 114         if (periph_drivers)
 115                 bcopy(periph_drivers, newdrivers,
 116                       sizeof(*newdrivers) * nperiph_drivers);
 117         newdrivers[nperiph_drivers] = drv;
 118         newdrivers[nperiph_drivers + 1] = NULL;
 119         old = periph_drivers;
 120         periph_drivers = newdrivers;
 121         if (old)
 122                 free(old, M_CAMPERIPH);
 123         nperiph_drivers++;
 124         /* If driver marked as early or it is late now, initialize it. */
 125         if (((drv->flags & CAM_PERIPH_DRV_EARLY) != 0 && initialized > 0) ||
 126             initialized > 1)
 127                 (*drv->init)();
 128 }
 129
 130 void
 131 periphdriver_init(int level)
 132 {
 133         int     i, early;
 134
 135         initialized = max(initialized, level);
 136         for (i = 0; periph_drivers[i] != NULL; i++) {
 137                 early = (periph_drivers[i]->flags & CAM_PERIPH_DRV_EARLY) ? 1 : 2;
 138                 if (early == initialized)
 139                         (*periph_drivers[i]->init)();
 140         }
 141 }
 142
 143 cam_status
 144 cam_periph_alloc(periph_ctor_t *periph_ctor,
 145                  periph_oninv_t *periph_oninvalidate,
 146                  periph_dtor_t *periph_dtor, periph_start_t *periph_start,
 147                  char *name, cam_periph_type type, struct cam_path *path,
 148                  ac_callback_t *ac_callback, ac_code code, void *arg)
 149 {
 150         struct          periph_driver **p_drv;
 151         struct          cam_sim *sim;
 152         struct          cam_periph *periph;
 153         struct          cam_periph *cur_periph;
 154         path_id_t       path_id;
 155         target_id_t     target_id;
 156         lun_id_t        lun_id;
 157         cam_status      status;
 158         u_int           init_level;
 159
 160         init_level = 0;
 161         /*
 162          * Handle Hot-Plug scenarios.  If there is already a peripheral
 163          * of our type assigned to this path, we are likely waiting for
 164          * final close on an old, invalidated, peripheral.  If this is
 165          * the case, queue up a deferred call to the peripheral's async
 166          * handler.  If it looks like a mistaken re-allocation, complain.
 167          */
 168         if ((periph = cam_periph_find(path, name)) != NULL) {
 169
 170                 if ((periph->flags & CAM_PERIPH_INVALID) != 0
 171                  && (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) == 0) {
 172                         periph->flags |= CAM_PERIPH_NEW_DEV_FOUND;
 173                         periph->deferred_callback = ac_callback;
 174                         periph->deferred_ac = code;
 175                         return (CAM_REQ_INPROG);
 176                 } else {
 177                         printf("cam_periph_alloc: attempt to re-allocate "
 178                                "valid device %s%d rejected flags %#x "
 179                                "refcount %d\n", periph->periph_name,
 180                                periph->unit_number, periph->flags,
 181                                periph->refcount);
 182                 }
 183                 return (CAM_REQ_INVALID);
 184         }
 185
 186         periph = (struct cam_periph *)malloc(sizeof(*periph), M_CAMPERIPH,
 187                                              M_NOWAIT|M_ZERO);
 188
 189         if (periph == NULL)
 190                 return (CAM_RESRC_UNAVAIL);
 191
 192         init_level++;
 193
 194
 195         sim = xpt_path_sim(path);
 196         path_id = xpt_path_path_id(path);
 197         target_id = xpt_path_target_id(path);
 198         lun_id = xpt_path_lun_id(path);
 199         cam_init_pinfo(&periph->pinfo);
 200         periph->periph_start = periph_start;
 201         periph->periph_dtor = periph_dtor;
 202         periph->periph_oninval = periph_oninvalidate;
 203         periph->type = type;
 204         periph->periph_name = name;
 205         periph->immediate_priority = CAM_PRIORITY_NONE;
 206         periph->refcount = 0;
 207         periph->sim = sim;
 208         SLIST_INIT(&periph->ccb_list);
 209         status = xpt_create_path(&path, periph, path_id, target_id, lun_id);
 210         if (status != CAM_REQ_CMP)
 211                 goto failure;
 212         periph->path = path;
 213
 214         xpt_lock_buses();
 215         for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
 216                 if (strcmp((*p_drv)->driver_name, name) == 0)
 217                         break;
 218         }
 219         if (*p_drv == NULL) {
 220                 printf("cam_periph_alloc: invalid periph name '%s'\n", name);
 221                 xpt_free_path(periph->path);
 222                 free(periph, M_CAMPERIPH);
 223                 xpt_unlock_buses();
 224                 return (CAM_REQ_INVALID);
 225         }
 226         periph->unit_number = camperiphunit(*p_drv, path_id, target_id, lun_id);
 227         cur_periph = TAILQ_FIRST(&(*p_drv)->units);
 228         while (cur_periph != NULL
 229             && cur_periph->unit_number < periph->unit_number)
 230                 cur_periph = TAILQ_NEXT(cur_periph, unit_links);
 231         if (cur_periph != NULL) {
 232                 KASSERT(cur_periph->unit_number != periph->unit_number, ("duplicate units on periph list"));
 233                 TAILQ_INSERT_BEFORE(cur_periph, periph, unit_links);
 234         } else {
 235                 TAILQ_INSERT_TAIL(&(*p_drv)->units, periph, unit_links);
 236                 (*p_drv)->generation++;
 237         }
 238         xpt_unlock_buses();
 239
 240         init_level++;
 241
 242         status = xpt_add_periph(periph);
 243         if (status != CAM_REQ_CMP)
 244                 goto failure;
 245
 246         init_level++;
 247         CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph created\n"));
 248
 249         status = periph_ctor(periph, arg);
 250
 251         if (status == CAM_REQ_CMP)
 252                 init_level++;
 253
 254 failure:
 255         switch (init_level) {
 256         case 4:
 257                 /* Initialized successfully */
 258                 break;
 259         case 3:
 260                 CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
 261                 xpt_remove_periph(periph, /*topology_lock_held*/ 0);
 262                 /* FALLTHROUGH */
 263         case 2:
 264                 xpt_lock_buses();
 265                 TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
 266                 xpt_unlock_buses();
 267                 xpt_free_path(periph->path);
 268                 /* FALLTHROUGH */
 269         case 1:
 270                 free(periph, M_CAMPERIPH);
 271                 /* FALLTHROUGH */
 272         case 0:
 273                 /* No cleanup to perform. */
 274                 break;
 275         default:
 276                 panic("%s: Unknown init level", __func__);
 277         }
 278         return(status);
 279 }
 280
 281 /*
 282  * Find a peripheral structure with the specified path, target, lun,
 283  * and (optionally) type.  If the name is NULL, this function will return
 284  * the first peripheral driver that matches the specified path.
 285  */
 286 struct cam_periph *
 287 cam_periph_find(struct cam_path *path, char *name)
 288 {
 289         struct periph_driver **p_drv;
 290         struct cam_periph *periph;
 291
 292         xpt_lock_buses();
 293         for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
 294
 295                 if (name != NULL && (strcmp((*p_drv)->driver_name, name) != 0))
 296                         continue;
 297
 298                 TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
 299                         if (xpt_path_comp(periph->path, path) == 0) {
 300                                 xpt_unlock_buses();
 301                                 mtx_assert(periph->sim->mtx, MA_OWNED);
 302                                 return(periph);
 303                         }
 304                 }
 305                 if (name != NULL) {
 306                         xpt_unlock_buses();
 307                         return(NULL);
 308                 }
 309         }
 310         xpt_unlock_buses();
 311         return(NULL);
 312 }
 313
 314 /*
 315  * Find peripheral driver instances attached to the specified path.
 316  */
 317 int
 318 cam_periph_list(struct cam_path *path, struct sbuf *sb)
 319 {
 320         struct sbuf local_sb;
 321         struct periph_driver **p_drv;
 322         struct cam_periph *periph;
 323         int count;
 324         int sbuf_alloc_len;
 325
 326         sbuf_alloc_len = 16;
 327 retry:
 328         sbuf_new(&local_sb, NULL, sbuf_alloc_len, SBUF_FIXEDLEN);
 329         count = 0;
 330         xpt_lock_buses();
 331         for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
 332
 333                 TAILQ_FOREACH(periph, &(*p_drv)->units, unit_links) {
 334                         if (xpt_path_comp(periph->path, path) != 0)
 335                                 continue;
 336
 337                         if (sbuf_len(&local_sb) != 0)
 338                                 sbuf_cat(&local_sb, ",");
 339
 340                         sbuf_printf(&local_sb, "%s%d", periph->periph_name,
 341                                     periph->unit_number);
 342
 343                         if (sbuf_error(&local_sb) == ENOMEM) {
 344                                 sbuf_alloc_len *= 2;
 345                                 xpt_unlock_buses();
 346                                 sbuf_delete(&local_sb);
 347                                 goto retry;
 348                         }
 349                         count++;
 350                 }
 351         }
 352         xpt_unlock_buses();
 353         sbuf_finish(&local_sb);
 354         sbuf_cpy(sb, sbuf_data(&local_sb));
 355         sbuf_delete(&local_sb);
 356         return (count);
 357 }
 358
 359 cam_status
 360 cam_periph_acquire(struct cam_periph *periph)
 361 {
 362         cam_status status;
 363
 364         status = CAM_REQ_CMP_ERR;
 365         if (periph == NULL)
 366                 return (status);
 367
 368         xpt_lock_buses();
 369         if ((periph->flags & CAM_PERIPH_INVALID) == 0) {
 370                 periph->refcount++;
 371                 status = CAM_REQ_CMP;
 372         }
 373         xpt_unlock_buses();
 374
 375         return (status);
 376 }
 377
 378 void
 379 cam_periph_release_locked_buses(struct cam_periph *periph)
 380 {
 381         if (periph->refcount != 0) {
 382                 periph->refcount--;
 383         } else {
 384                 panic("%s: release of %p when refcount is zero\n ", __func__,
 385                       periph);
 386         }
 387         if (periph->refcount == 0
 388             && (periph->flags & CAM_PERIPH_INVALID)) {
 389                 camperiphfree(periph);
 390         }
 391 }
 392
 393 void
 394 cam_periph_release_locked(struct cam_periph *periph)
 395 {
 396
 397         if (periph == NULL)
 398                 return;
 399
 400         xpt_lock_buses();
 401         cam_periph_release_locked_buses(periph);
 402         xpt_unlock_buses();
 403 }
 404
 405 void
 406 cam_periph_release(struct cam_periph *periph)
 407 {
 408         struct cam_sim *sim;
 409
 410         if (periph == NULL)
 411                 return;
 412
 413         sim = periph->sim;
 414         mtx_assert(sim->mtx, MA_NOTOWNED);
 415         mtx_lock(sim->mtx);
 416         cam_periph_release_locked(periph);
 417         mtx_unlock(sim->mtx);
 418 }
 419
 420 int
 421 cam_periph_hold(struct cam_periph *periph, int priority)
 422 {
 423         int error;
 424
 425         /*
 426          * Increment the reference count on the peripheral
 427          * while we wait for our lock attempt to succeed
 428          * to ensure the peripheral doesn't disappear out
 429          * from user us while we sleep.
 430          */
 431
 432         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
 433                 return (ENXIO);
 434
 435         mtx_assert(periph->sim->mtx, MA_OWNED);
 436         while ((periph->flags & CAM_PERIPH_LOCKED) != 0) {
 437                 periph->flags |= CAM_PERIPH_LOCK_WANTED;
 438                 if ((error = mtx_sleep(periph, periph->sim->mtx, priority,
 439                     "caplck", 0)) != 0) {
 440                         cam_periph_release_locked(periph);
 441                         return (error);
 442                 }
 443                 if (periph->flags & CAM_PERIPH_INVALID) {
 444                         cam_periph_release_locked(periph);
 445                         return (ENXIO);
 446                 }
 447         }
 448
 449         periph->flags |= CAM_PERIPH_LOCKED;
 450         return (0);
 451 }
 452
 453 void
 454 cam_periph_unhold(struct cam_periph *periph)
 455 {
 456
 457         mtx_assert(periph->sim->mtx, MA_OWNED);
 458
 459         periph->flags &= ~CAM_PERIPH_LOCKED;
 460         if ((periph->flags & CAM_PERIPH_LOCK_WANTED) != 0) {
 461                 periph->flags &= ~CAM_PERIPH_LOCK_WANTED;
 462                 wakeup(periph);
 463         }
 464
 465         cam_periph_release_locked(periph);
 466 }
 467
 468 /*
 469  * Look for the next unit number that is not currently in use for this
 470  * peripheral type starting at "newunit".  Also exclude unit numbers that
 471  * are reserved by for future "hardwiring" unless we already know that this
 472  * is a potential wired device.  Only assume that the device is "wired" the
 473  * first time through the loop since after that we'll be looking at unit
 474  * numbers that did not match a wiring entry.
 475  */
 476 static u_int
 477 camperiphnextunit(struct periph_driver *p_drv, u_int newunit, int wired,
 478                   path_id_t pathid, target_id_t target, lun_id_t lun)
 479 {
 480         struct  cam_periph *periph;
 481         char    *periph_name;
 482         int     i, val, dunit, r;
 483         const char *dname, *strval;
 484
 485         periph_name = p_drv->driver_name;
 486         for (;;newunit++) {
 487
 488                 for (periph = TAILQ_FIRST(&p_drv->units);
 489                      periph != NULL && periph->unit_number != newunit;
 490                      periph = TAILQ_NEXT(periph, unit_links))
 491                         ;
 492
 493                 if (periph != NULL && periph->unit_number == newunit) {
 494                         if (wired != 0) {
 495                                 xpt_print(periph->path, "Duplicate Wired "
 496                                     "Device entry!\n");
 497                                 xpt_print(periph->path, "Second device (%s "
 498                                     "device at scbus%d target %d lun %d) will "
 499                                     "not be wired\n", periph_name, pathid,
 500                                     target, lun);
 501                                 wired = 0;
 502                         }
 503                         continue;
 504                 }
 505                 if (wired)
 506                         break;
 507
 508                 /*
 509                  * Don't match entries like "da 4" as a wired down
 510                  * device, but do match entries like "da 4 target 5"
 511                  * or even "da 4 scbus 1".
 512                  */
 513                 i = 0;
 514                 dname = periph_name;
 515                 for (;;) {
 516                         r = resource_find_dev(&i, dname, &dunit, NULL, NULL);
 517                         if (r != 0)
 518                                 break;
 519                         /* if no "target" and no specific scbus, skip */
 520                         if (resource_int_value(dname, dunit, "target", &val) &&
 521                             (resource_string_value(dname, dunit, "at",&strval)||
 522                              strcmp(strval, "scbus") == 0))
 523                                 continue;
 524                         if (newunit == dunit)
 525                                 break;
 526                 }
 527                 if (r != 0)
 528                         break;
 529         }
 530         return (newunit);
 531 }
 532
 533 static u_int
 534 camperiphunit(struct periph_driver *p_drv, path_id_t pathid,
 535               target_id_t target, lun_id_t lun)
 536 {
 537         u_int   unit;
 538         int     wired, i, val, dunit;
 539         const char *dname, *strval;
 540         char    pathbuf[32], *periph_name;
 541
 542         periph_name = p_drv->driver_name;
 543         snprintf(pathbuf, sizeof(pathbuf), "scbus%d", pathid);
 544         unit = 0;
 545         i = 0;
 546         dname = periph_name;
 547         for (wired = 0; resource_find_dev(&i, dname, &dunit, NULL, NULL) == 0;
 548              wired = 0) {
 549                 if (resource_string_value(dname, dunit, "at", &strval) == 0) {
 550                         if (strcmp(strval, pathbuf) != 0)
 551                                 continue;
 552                         wired++;
 553                 }
 554                 if (resource_int_value(dname, dunit, "target", &val) == 0) {
 555                         if (val != target)
 556                                 continue;
 557                         wired++;
 558                 }
 559                 if (resource_int_value(dname, dunit, "lun", &val) == 0) {
 560                         if (val != lun)
 561                                 continue;
 562                         wired++;
 563                 }
 564                 if (wired != 0) {
 565                         unit = dunit;
 566                         break;
 567                 }
 568         }
 569
 570         /*
 571          * Either start from 0 looking for the next unit or from
 572          * the unit number given in the resource config.  This way,
 573          * if we have wildcard matches, we don't return the same
 574          * unit number twice.
 575          */
 576         unit = camperiphnextunit(p_drv, unit, wired, pathid, target, lun);
 577
 578         return (unit);
 579 }
 580
 581 void
 582 cam_periph_invalidate(struct cam_periph *periph)
 583 {
 584
 585         CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph invalidated\n"));
 586         /*
 587          * We only call this routine the first time a peripheral is
 588          * invalidated.
 589          */
 590         if (((periph->flags & CAM_PERIPH_INVALID) == 0)
 591          && (periph->periph_oninval != NULL))
 592                 periph->periph_oninval(periph);
 593
 594         periph->flags |= CAM_PERIPH_INVALID;
 595         periph->flags &= ~CAM_PERIPH_NEW_DEV_FOUND;
 596
 597         xpt_lock_buses();
 598         if (periph->refcount == 0)
 599                 camperiphfree(periph);
 600         xpt_unlock_buses();
 601 }
 602
 603 static void
 604 camperiphfree(struct cam_periph *periph)
 605 {
 606         struct periph_driver **p_drv;
 607
 608         for (p_drv = periph_drivers; *p_drv != NULL; p_drv++) {
 609                 if (strcmp((*p_drv)->driver_name, periph->periph_name) == 0)
 610                         break;
 611         }
 612         if (*p_drv == NULL) {
 613                 printf("camperiphfree: attempt to free non-existant periph\n");
 614                 return;
 615         }
 616
 617         /*
 618          * We need to set this flag before dropping the topology lock, to
 619          * let anyone who is traversing the list that this peripheral is
 620          * about to be freed, and there will be no more reference count
 621          * checks.
 622          */
 623         periph->flags |= CAM_PERIPH_FREE;
 624
 625         /*
 626          * The peripheral destructor semantics dictate calling with only the
 627          * SIM mutex held.  Since it might sleep, it should not be called
 628          * with the topology lock held.
 629          */
 630         xpt_unlock_buses();
 631
 632         /*
 633          * We need to call the peripheral destructor prior to removing the
 634          * peripheral from the list.  Otherwise, we risk running into a
 635          * scenario where the peripheral unit number may get reused
 636          * (because it has been removed from the list), but some resources
 637          * used by the peripheral are still hanging around.  In particular,
 638          * the devfs nodes used by some peripherals like the pass(4) driver
 639          * aren't fully cleaned up until the destructor is run.  If the
 640          * unit number is reused before the devfs instance is fully gone,
 641          * devfs will panic.
 642          */
 643         if (periph->periph_dtor != NULL)
 644                 periph->periph_dtor(periph);
 645
 646         /*
 647          * The peripheral list is protected by the topology lock.
 648          */
 649         xpt_lock_buses();
 650
 651         TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
 652         (*p_drv)->generation++;
 653
 654         xpt_remove_periph(periph, /*topology_lock_held*/ 1);
 655
 656         xpt_unlock_buses();
 657         CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
 658
 659         if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
 660                 union ccb ccb;
 661                 void *arg;
 662
 663                 switch (periph->deferred_ac) {
 664                 case AC_FOUND_DEVICE:
 665                         ccb.ccb_h.func_code = XPT_GDEV_TYPE;
 666                         xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 667                         xpt_action(&ccb);
 668                         arg = &ccb;
 669                         break;
 670                 case AC_PATH_REGISTERED:
 671                         ccb.ccb_h.func_code = XPT_PATH_INQ;
 672                         xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 673                         xpt_action(&ccb);
 674                         arg = &ccb;
 675                         break;
 676                 default:
 677                         arg = NULL;
 678                         break;
 679                 }
 680                 periph->deferred_callback(NULL, periph->deferred_ac,
 681                                           periph->path, arg);
 682         }
 683         xpt_free_path(periph->path);
 684         free(periph, M_CAMPERIPH);
 685         xpt_lock_buses();
 686 }
 687
 688 /*
 689  * Map user virtual pointers into kernel virtual address space, so we can
 690  * access the memory.  This won't work on physical pointers, for now it's
 691  * up to the caller to check for that.  (XXX KDM -- should we do that here
 692  * instead?)  This also only works for up to MAXPHYS memory.  Since we use
 693  * buffers to map stuff in and out, we're limited to the buffer size.
 694  */
 695 int
 696 cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
 697 {
 698         int numbufs, i, j;
 699         int flags[CAM_PERIPH_MAXMAPS];
 700         u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
 701         u_int32_t lengths[CAM_PERIPH_MAXMAPS];
 702         u_int32_t dirs[CAM_PERIPH_MAXMAPS];
 703         /* Some controllers may not be able to handle more data. */
 704         size_t maxmap = DFLTPHYS;
 705
 706         switch(ccb->ccb_h.func_code) {
 707         case XPT_DEV_MATCH:
 708                 if (ccb->cdm.match_buf_len == 0) {
 709                         printf("cam_periph_mapmem: invalid match buffer "
 710                                "length 0\n");
 711                         return(EINVAL);
 712                 }
 713                 if (ccb->cdm.pattern_buf_len > 0) {
 714                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
 715                         lengths[0] = ccb->cdm.pattern_buf_len;
 716                         dirs[0] = CAM_DIR_OUT;
 717                         data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
 718                         lengths[1] = ccb->cdm.match_buf_len;
 719                         dirs[1] = CAM_DIR_IN;
 720                         numbufs = 2;
 721                 } else {
 722                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
 723                         lengths[0] = ccb->cdm.match_buf_len;
 724                         dirs[0] = CAM_DIR_IN;
 725                         numbufs = 1;
 726                 }
 727                 /*
 728                  * This request will not go to the hardware, no reason
 729                  * to be so strict. vmapbuf() is able to map up to MAXPHYS.
 730                  */
 731                 maxmap = MAXPHYS;
 732                 break;
 733         case XPT_SCSI_IO:
 734         case XPT_CONT_TARGET_IO:
 735                 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
 736                         return(0);
 737                 KASSERT((ccb->ccb_h.flags & CAM_DATA_MASK) == CAM_DATA_VADDR,
 738                     ("not VADDR for SCSI_IO %p %x\n", ccb, ccb->ccb_h.flags));
 739
 740                 data_ptrs[0] = &ccb->csio.data_ptr;
 741                 lengths[0] = ccb->csio.dxfer_len;
 742                 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
 743                 numbufs = 1;
 744                 break;
 745         case XPT_ATA_IO:
 746                 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
 747                         return(0);
 748                 KASSERT((ccb->ccb_h.flags & CAM_DATA_MASK) == CAM_DATA_VADDR,
 749                     ("not VADDR for ATA_IO %p %x\n", ccb, ccb->ccb_h.flags));
 750
 751                 data_ptrs[0] = &ccb->ataio.data_ptr;
 752                 lengths[0] = ccb->ataio.dxfer_len;
 753                 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
 754                 numbufs = 1;
 755                 break;
 756         case XPT_SMP_IO:
 757                 data_ptrs[0] = &ccb->smpio.smp_request;
 758                 lengths[0] = ccb->smpio.smp_request_len;
 759                 dirs[0] = CAM_DIR_OUT;
 760                 data_ptrs[1] = &ccb->smpio.smp_response;
 761                 lengths[1] = ccb->smpio.smp_response_len;
 762                 dirs[1] = CAM_DIR_IN;
 763                 numbufs = 2;
 764                 break;
 765         case XPT_DEV_ADVINFO:
 766                 if (ccb->cdai.bufsiz == 0)
 767                         return (0);
 768
 769                 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
 770                 lengths[0] = ccb->cdai.bufsiz;
 771                 dirs[0] = CAM_DIR_IN;
 772                 numbufs = 1;
 773
 774                 /*
 775                  * This request will not go to the hardware, no reason
 776                  * to be so strict. vmapbuf() is able to map up to MAXPHYS.
 777                  */
 778                 maxmap = MAXPHYS;
 779                 break;
 780         default:
 781                 return(EINVAL);
 782                 break; /* NOTREACHED */
 783         }
 784
 785         /*
 786          * Check the transfer length and permissions first, so we don't
 787          * have to unmap any previously mapped buffers.
 788          */
 789         for (i = 0; i < numbufs; i++) {
 790
 791                 flags[i] = 0;
 792
 793                 /*
 794                  * The userland data pointer passed in may not be page
 795                  * aligned.  vmapbuf() truncates the address to a page
 796                  * boundary, so if the address isn't page aligned, we'll
 797                  * need enough space for the given transfer length, plus
 798                  * whatever extra space is necessary to make it to the page
 799                  * boundary.
 800                  */
 801                 if ((lengths[i] +
 802                     (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)) > maxmap){
 803                         printf("cam_periph_mapmem: attempt to map %lu bytes, "
 804                                "which is greater than %lu\n",
 805                                (long)(lengths[i] +
 806                                (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)),
 807                                (u_long)maxmap);
 808                         return(E2BIG);
 809                 }
 810
 811                 if (dirs[i] & CAM_DIR_OUT) {
 812                         flags[i] = BIO_WRITE;
 813                 }
 814
 815                 if (dirs[i] & CAM_DIR_IN) {
 816                         flags[i] = BIO_READ;
 817                 }
 818
 819         }
 820
 821         /* this keeps the current process from getting swapped */
 822         /*
 823          * XXX KDM should I use P_NOSWAP instead?
 824          */
 825         PHOLD(curproc);
 826
 827         for (i = 0; i < numbufs; i++) {
 828                 /*
 829                  * Get the buffer.
 830                  */
 831                 mapinfo->bp[i] = getpbuf(NULL);
 832
 833                 /* save the buffer's data address */
 834                 mapinfo->bp[i]->b_saveaddr = mapinfo->bp[i]->b_data;
 835
 836                 /* put our pointer in the data slot */
 837                 mapinfo->bp[i]->b_data = *data_ptrs[i];
 838
 839                 /* set the transfer length, we know it's < MAXPHYS */
 840                 mapinfo->bp[i]->b_bufsize = lengths[i];
 841
 842                 /* set the direction */
 843                 mapinfo->bp[i]->b_iocmd = flags[i];
 844
 845                 /*
 846                  * Map the buffer into kernel memory.
 847                  *
 848                  * Note that useracc() alone is not a  sufficient test.
 849                  * vmapbuf() can still fail due to a smaller file mapped
 850                  * into a larger area of VM, or if userland races against
 851                  * vmapbuf() after the useracc() check.
 852                  */
 853                 if (vmapbuf(mapinfo->bp[i], 1) < 0) {
 854                         for (j = 0; j < i; ++j) {
 855                                 *data_ptrs[j] = mapinfo->bp[j]->b_saveaddr;
 856                                 vunmapbuf(mapinfo->bp[j]);
 857                                 relpbuf(mapinfo->bp[j], NULL);
 858                         }
 859                         relpbuf(mapinfo->bp[i], NULL);
 860                         PRELE(curproc);
 861                         return(EACCES);
 862                 }
 863
 864                 /* set our pointer to the new mapped area */
 865                 *data_ptrs[i] = mapinfo->bp[i]->b_data;
 866
 867                 mapinfo->num_bufs_used++;
 868         }
 869
 870         /*
 871          * Now that we've gotten this far, change ownership to the kernel
 872          * of the buffers so that we don't run afoul of returning to user
 873          * space with locks (on the buffer) held.
 874          */
 875         for (i = 0; i < numbufs; i++) {
 876                 BUF_KERNPROC(mapinfo->bp[i]);
 877         }
 878
 879
 880         return(0);
 881 }
 882
 883 /*
 884  * Unmap memory segments mapped into kernel virtual address space by
 885  * cam_periph_mapmem().
 886  */
 887 void
 888 cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
 889 {
 890         int numbufs, i;
 891         u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
 892
 893         if (mapinfo->num_bufs_used <= 0) {
 894                 /* allow ourselves to be swapped once again */
 895                 PRELE(curproc);
 896                 return;
 897         }
 898
 899         switch (ccb->ccb_h.func_code) {
 900         case XPT_DEV_MATCH:
 901                 numbufs = min(mapinfo->num_bufs_used, 2);
 902
 903                 if (numbufs == 1) {
 904                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
 905                 } else {
 906                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
 907                         data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
 908                 }
 909                 break;
 910         case XPT_SCSI_IO:
 911         case XPT_CONT_TARGET_IO:
 912                 data_ptrs[0] = &ccb->csio.data_ptr;
 913                 numbufs = min(mapinfo->num_bufs_used, 1);
 914                 break;
 915         case XPT_ATA_IO:
 916                 data_ptrs[0] = &ccb->ataio.data_ptr;
 917                 numbufs = min(mapinfo->num_bufs_used, 1);
 918                 break;
 919         case XPT_SMP_IO:
 920                 numbufs = min(mapinfo->num_bufs_used, 2);
 921                 data_ptrs[0] = &ccb->smpio.smp_request;
 922                 data_ptrs[1] = &ccb->smpio.smp_response;
 923                 break;
 924         case XPT_DEV_ADVINFO:
 925                 numbufs = min(mapinfo->num_bufs_used, 1);
 926                 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
 927                 break;
 928         default:
 929                 /* allow ourselves to be swapped once again */
 930                 PRELE(curproc);
 931                 return;
 932                 break; /* NOTREACHED */
 933         }
 934
 935         for (i = 0; i < numbufs; i++) {
 936                 /* Set the user's pointer back to the original value */
 937                 *data_ptrs[i] = mapinfo->bp[i]->b_saveaddr;
 938
 939                 /* unmap the buffer */
 940                 vunmapbuf(mapinfo->bp[i]);
 941
 942                 /* release the buffer */
 943                 relpbuf(mapinfo->bp[i], NULL);
 944         }
 945
 946         /* allow ourselves to be swapped once again */
 947         PRELE(curproc);
 948 }
 949
 950 union ccb *
 951 cam_periph_getccb(struct cam_periph *periph, u_int32_t priority)
 952 {
 953         struct ccb_hdr *ccb_h;
 954
 955         mtx_assert(periph->sim->mtx, MA_OWNED);
 956         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdgetccb\n"));
 957
 958         while (SLIST_FIRST(&periph->ccb_list) == NULL) {
 959                 if (periph->immediate_priority > priority)
 960                         periph->immediate_priority = priority;
 961                 xpt_schedule(periph, priority);
 962                 if ((SLIST_FIRST(&periph->ccb_list) != NULL)
 963                  && (SLIST_FIRST(&periph->ccb_list)->pinfo.priority == priority))
 964                         break;
 965                 mtx_assert(periph->sim->mtx, MA_OWNED);
 966                 mtx_sleep(&periph->ccb_list, periph->sim->mtx, PRIBIO, "cgticb",
 967                     0);
 968         }
 969
 970         ccb_h = SLIST_FIRST(&periph->ccb_list);
 971         SLIST_REMOVE_HEAD(&periph->ccb_list, periph_links.sle);
 972         return ((union ccb *)ccb_h);
 973 }
 974
 975 void
 976 cam_periph_ccbwait(union ccb *ccb)
 977 {
 978         struct cam_sim *sim;
 979
 980         sim = xpt_path_sim(ccb->ccb_h.path);
 981         if ((ccb->ccb_h.pinfo.index != CAM_UNQUEUED_INDEX)
 982          || ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG))
 983                 mtx_sleep(&ccb->ccb_h.cbfcnp, sim->mtx, PRIBIO, "cbwait", 0);
 984 }
 985
 986 int
 987 cam_periph_ioctl(struct cam_periph *periph, u_long cmd, caddr_t addr,
 988                  int (*error_routine)(union ccb *ccb,
 989                                       cam_flags camflags,
 990                                       u_int32_t sense_flags))
 991 {
 992         union ccb            *ccb;
 993         int                  error;
 994         int                  found;
 995
 996         error = found = 0;
 997
 998         switch(cmd){
 999         case CAMGETPASSTHRU:
1000                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1001                 xpt_setup_ccb(&ccb->ccb_h,
1002                               ccb->ccb_h.path,
1003                               CAM_PRIORITY_NORMAL);
1004                 ccb->ccb_h.func_code = XPT_GDEVLIST;
1005
1006                 /*
1007                  * Basically, the point of this is that we go through
1008                  * getting the list of devices, until we find a passthrough
1009                  * device.  In the current version of the CAM code, the
1010                  * only way to determine what type of device we're dealing
1011                  * with is by its name.
1012                  */
1013                 while (found == 0) {
1014                         ccb->cgdl.index = 0;
1015                         ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
1016                         while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
1017
1018                                 /* we want the next device in the list */
1019                                 xpt_action(ccb);
1020                                 if (strncmp(ccb->cgdl.periph_name,
1021                                     "pass", 4) == 0){
1022                                         found = 1;
1023                                         break;
1024                                 }
1025                         }
1026                         if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
1027                             (found == 0)) {
1028                                 ccb->cgdl.periph_name[0] = '\0';
1029                                 ccb->cgdl.unit_number = 0;
1030                                 break;
1031                         }
1032                 }
1033
1034                 /* copy the result back out */
1035                 bcopy(ccb, addr, sizeof(union ccb));
1036
1037                 /* and release the ccb */
1038                 xpt_release_ccb(ccb);
1039
1040                 break;
1041         default:
1042                 error = ENOTTY;
1043                 break;
1044         }
1045         return(error);
1046 }
1047
1048 int
1049 cam_periph_runccb(union ccb *ccb,
1050                   int (*error_routine)(union ccb *ccb,
1051                                        cam_flags camflags,
1052                                        u_int32_t sense_flags),
1053                   cam_flags camflags, u_int32_t sense_flags,
1054                   struct devstat *ds)
1055 {
1056         struct cam_sim *sim;
1057         int error;
1058
1059         error = 0;
1060         sim = xpt_path_sim(ccb->ccb_h.path);
1061         mtx_assert(sim->mtx, MA_OWNED);
1062
1063         /*
1064          * If the user has supplied a stats structure, and if we understand
1065          * this particular type of ccb, record the transaction start.
1066          */
1067         if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO ||
1068             ccb->ccb_h.func_code == XPT_ATA_IO))
1069                 devstat_start_transaction(ds, NULL);
1070
1071         xpt_action(ccb);
1072
1073         do {
1074                 cam_periph_ccbwait(ccb);
1075                 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
1076                         error = 0;
1077                 else if (error_routine != NULL)
1078                         error = (*error_routine)(ccb, camflags, sense_flags);
1079                 else
1080                         error = 0;
1081
1082         } while (error == ERESTART);
1083
1084         if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1085                 cam_release_devq(ccb->ccb_h.path,
1086                                  /* relsim_flags */0,
1087                                  /* openings */0,
1088                                  /* timeout */0,
1089                                  /* getcount_only */ FALSE);
1090                 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1091         }
1092
1093         if (ds != NULL) {
1094                 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
1095                         devstat_end_transaction(ds,
1096                                         ccb->csio.dxfer_len,
1097                                         ccb->csio.tag_action & 0x3,
1098                                         ((ccb->ccb_h.flags & CAM_DIR_MASK) ==
1099                                         CAM_DIR_NONE) ?  DEVSTAT_NO_DATA :
1100                                         (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1101                                         DEVSTAT_WRITE :
1102                                         DEVSTAT_READ, NULL, NULL);
1103                 } else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
1104                         devstat_end_transaction(ds,
1105                                         ccb->ataio.dxfer_len,
1106                                         ccb->ataio.tag_action & 0x3,
1107                                         ((ccb->ccb_h.flags & CAM_DIR_MASK) ==
1108                                         CAM_DIR_NONE) ?  DEVSTAT_NO_DATA :
1109                                         (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1110                                         DEVSTAT_WRITE :
1111                                         DEVSTAT_READ, NULL, NULL);
1112                 }
1113         }
1114
1115         return(error);
1116 }
1117
1118 void
1119 cam_freeze_devq(struct cam_path *path)
1120 {
1121
1122         cam_freeze_devq_arg(path, 0, 0);
1123 }
1124
1125 void
1126 cam_freeze_devq_arg(struct cam_path *path, uint32_t flags, uint32_t arg)
1127 {
1128         struct ccb_relsim crs;
1129
1130         xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NONE);
1131         crs.ccb_h.func_code = XPT_FREEZE_QUEUE;
1132         crs.release_flags = flags;
1133         crs.openings = arg;
1134         crs.release_timeout = arg;
1135         xpt_action((union ccb *)&crs);
1136 }
1137
1138 u_int32_t
1139 cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
1140                  u_int32_t openings, u_int32_t arg,
1141                  int getcount_only)
1142 {
1143         struct ccb_relsim crs;
1144
1145         xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NORMAL);
1146         crs.ccb_h.func_code = XPT_REL_SIMQ;
1147         crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
1148         crs.release_flags = relsim_flags;
1149         crs.openings = openings;
1150         crs.release_timeout = arg;
1151         xpt_action((union ccb *)&crs);
1152         return (crs.qfrozen_cnt);
1153 }
1154
1155 #define saved_ccb_ptr ppriv_ptr0
1156 static void
1157 camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
1158 {
1159         union ccb      *saved_ccb;
1160         cam_status      status;
1161         struct scsi_start_stop_unit *scsi_cmd;
1162         int    error_code, sense_key, asc, ascq;
1163
1164         scsi_cmd = (struct scsi_start_stop_unit *)
1165             &done_ccb->csio.cdb_io.cdb_bytes;
1166         status = done_ccb->ccb_h.status;
1167
1168         if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1169                 if (scsi_extract_sense_ccb(done_ccb,
1170                     &error_code, &sense_key, &asc, &ascq)) {
1171                         /*
1172                          * If the error is "invalid field in CDB",
1173                          * and the load/eject flag is set, turn the
1174                          * flag off and try again.  This is just in
1175                          * case the drive in question barfs on the
1176                          * load eject flag.  The CAM code should set
1177                          * the load/eject flag by default for
1178                          * removable media.
1179                          */
1180                         if ((scsi_cmd->opcode == START_STOP_UNIT) &&
1181                             ((scsi_cmd->how & SSS_LOEJ) != 0) &&
1182                              (asc == 0x24) && (ascq == 0x00)) {
1183                                 scsi_cmd->how &= ~SSS_LOEJ;
1184                                 if (status & CAM_DEV_QFRZN) {
1185                                         cam_release_devq(done_ccb->ccb_h.path,
1186                                             0, 0, 0, 0);
1187                                         done_ccb->ccb_h.status &=
1188                                             ~CAM_DEV_QFRZN;
1189                                 }
1190                                 xpt_action(done_ccb);
1191                                 goto out;
1192                         }
1193                 }
1194                 if (cam_periph_error(done_ccb,
1195                     0, SF_RETRY_UA | SF_NO_PRINT, NULL) == ERESTART)
1196                         goto out;
1197                 if (done_ccb->ccb_h.status & CAM_DEV_QFRZN) {
1198                         cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1199                         done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1200                 }
1201         } else {
1202                 /*
1203                  * If we have successfully taken a device from the not
1204                  * ready to ready state, re-scan the device and re-get
1205                  * the inquiry information.  Many devices (mostly disks)
1206                  * don't properly report their inquiry information unless
1207                  * they are spun up.
1208                  */
1209                 if (scsi_cmd->opcode == START_STOP_UNIT)
1210                         xpt_async(AC_INQ_CHANGED, done_ccb->ccb_h.path, NULL);
1211         }
1212
1213         /*
1214          * Perform the final retry with the original CCB so that final
1215          * error processing is performed by the owner of the CCB.
1216          */
1217         saved_ccb = (union ccb *)done_ccb->ccb_h.saved_ccb_ptr;
1218         bcopy(saved_ccb, done_ccb, sizeof(*done_ccb));
1219         xpt_free_ccb(saved_ccb);
1220         if (done_ccb->ccb_h.cbfcnp != camperiphdone)
1221                 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1222         xpt_action(done_ccb);
1223
1224 out:
1225         /* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
1226         cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1227 }
1228
1229 /*
1230  * Generic Async Event handler.  Peripheral drivers usually
1231  * filter out the events that require personal attention,
1232  * and leave the rest to this function.
1233  */
1234 void
1235 cam_periph_async(struct cam_periph *periph, u_int32_t code,
1236                  struct cam_path *path, void *arg)
1237 {
1238         switch (code) {
1239         case AC_LOST_DEVICE:
1240                 cam_periph_invalidate(periph);
1241                 break;
1242         default:
1243                 break;
1244         }
1245 }
1246
1247 void
1248 cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
1249 {
1250         struct ccb_getdevstats cgds;
1251
1252         xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1253         cgds.ccb_h.func_code = XPT_GDEV_STATS;
1254         xpt_action((union ccb *)&cgds);
1255         cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
1256 }
1257
1258 void
1259 cam_periph_freeze_after_event(struct cam_periph *periph,
1260                               struct timeval* event_time, u_int duration_ms)
1261 {
1262         struct timeval delta;
1263         struct timeval duration_tv;
1264
1265         if (!timevalisset(event_time))
1266                 return;
1267
1268         microtime(&delta);
1269         timevalsub(&delta, event_time);
1270         duration_tv.tv_sec = duration_ms / 1000;
1271         duration_tv.tv_usec = (duration_ms % 1000) * 1000;
1272         if (timevalcmp(&delta, &duration_tv, <)) {
1273                 timevalsub(&duration_tv, &delta);
1274
1275                 duration_ms = duration_tv.tv_sec * 1000;
1276                 duration_ms += duration_tv.tv_usec / 1000;
1277                 cam_freeze_devq(periph->path);
1278                 cam_release_devq(periph->path,
1279                                 RELSIM_RELEASE_AFTER_TIMEOUT,
1280                                 /*reduction*/0,
1281                                 /*timeout*/duration_ms,
1282                                 /*getcount_only*/0);
1283         }
1284
1285 }
1286
1287 static int
1288 camperiphscsistatuserror(union ccb *ccb, union ccb **orig_ccb,
1289     cam_flags camflags, u_int32_t sense_flags,
1290     int *openings, u_int32_t *relsim_flags,
1291     u_int32_t *timeout, int *print, const char **action_string)
1292 {
1293         int error;
1294
1295         switch (ccb->csio.scsi_status) {
1296         case SCSI_STATUS_OK:
1297         case SCSI_STATUS_COND_MET:
1298         case SCSI_STATUS_INTERMED:
1299         case SCSI_STATUS_INTERMED_COND_MET:
1300                 error = 0;
1301                 break;
1302         case SCSI_STATUS_CMD_TERMINATED:
1303         case SCSI_STATUS_CHECK_COND:
1304                 error = camperiphscsisenseerror(ccb, orig_ccb,
1305                                                 camflags,
1306                                                 sense_flags,
1307                                                 openings,
1308                                                 relsim_flags,
1309                                                 timeout,
1310                                                 print,
1311                                                 action_string);
1312                 break;
1313         case SCSI_STATUS_QUEUE_FULL:
1314         {
1315                 /* no decrement */
1316                 struct ccb_getdevstats cgds;
1317
1318                 /*
1319                  * First off, find out what the current
1320                  * transaction counts are.
1321                  */
1322                 xpt_setup_ccb(&cgds.ccb_h,
1323                               ccb->ccb_h.path,
1324                               CAM_PRIORITY_NORMAL);
1325                 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1326                 xpt_action((union ccb *)&cgds);
1327
1328                 /*
1329                  * If we were the only transaction active, treat
1330                  * the QUEUE FULL as if it were a BUSY condition.
1331                  */
1332                 if (cgds.dev_active != 0) {
1333                         int total_openings;
1334
1335                         /*
1336                          * Reduce the number of openings to
1337                          * be 1 less than the amount it took
1338                          * to get a queue full bounded by the
1339                          * minimum allowed tag count for this
1340                          * device.
1341                          */
1342                         total_openings = cgds.dev_active + cgds.dev_openings;
1343                         *openings = cgds.dev_active;
1344                         if (*openings < cgds.mintags)
1345                                 *openings = cgds.mintags;
1346                         if (*openings < total_openings)
1347                                 *relsim_flags = RELSIM_ADJUST_OPENINGS;
1348                         else {
1349                                 /*
1350                                  * Some devices report queue full for
1351                                  * temporary resource shortages.  For
1352                                  * this reason, we allow a minimum
1353                                  * tag count to be entered via a
1354                                  * quirk entry to prevent the queue
1355                                  * count on these devices from falling
1356                                  * to a pessimisticly low value.  We
1357                                  * still wait for the next successful
1358                                  * completion, however, before queueing
1359                                  * more transactions to the device.
1360                                  */
1361                                 *relsim_flags = RELSIM_RELEASE_AFTER_CMDCMPLT;
1362                         }
1363                         *timeout = 0;
1364                         error = ERESTART;
1365                         *print = 0;
1366                         break;
1367                 }
1368                 /* FALLTHROUGH */
1369         }
1370         case SCSI_STATUS_BUSY:
1371                 /*
1372                  * Restart the queue after either another
1373                  * command completes or a 1 second timeout.
1374                  */
1375                 if (ccb->ccb_h.retry_count > 0) {
1376                         ccb->ccb_h.retry_count--;
1377                         error = ERESTART;
1378                         *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
1379                                       | RELSIM_RELEASE_AFTER_CMDCMPLT;
1380                         *timeout = 1000;
1381                 } else {
1382                         error = EIO;
1383                 }
1384                 break;
1385         case SCSI_STATUS_RESERV_CONFLICT:
1386         default:
1387                 error = EIO;
1388                 break;
1389         }
1390         return (error);
1391 }
1392
1393 static int
1394 camperiphscsisenseerror(union ccb *ccb, union ccb **orig,
1395     cam_flags camflags, u_int32_t sense_flags,
1396     int *openings, u_int32_t *relsim_flags,
1397     u_int32_t *timeout, int *print, const char **action_string)
1398 {
1399         struct cam_periph *periph;
1400         union ccb *orig_ccb = ccb;
1401         int error, recoveryccb;
1402
1403         periph = xpt_path_periph(ccb->ccb_h.path);
1404         recoveryccb = (ccb->ccb_h.cbfcnp == camperiphdone);
1405         if ((periph->flags & CAM_PERIPH_RECOVERY_INPROG) && !recoveryccb) {
1406                 /*
1407                  * If error recovery is already in progress, don't attempt
1408                  * to process this error, but requeue it unconditionally
1409                  * and attempt to process it once error recovery has
1410                  * completed.  This failed command is probably related to
1411                  * the error that caused the currently active error recovery
1412                  * action so our  current recovery efforts should also
1413                  * address this command.  Be aware that the error recovery
1414                  * code assumes that only one recovery action is in progress
1415                  * on a particular peripheral instance at any given time
1416                  * (e.g. only one saved CCB for error recovery) so it is
1417                  * imperitive that we don't violate this assumption.
1418                  */
1419                 error = ERESTART;
1420                 *print = 0;
1421         } else {
1422                 scsi_sense_action err_action;
1423                 struct ccb_getdev cgd;
1424
1425                 /*
1426                  * Grab the inquiry data for this device.
1427                  */
1428                 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path, CAM_PRIORITY_NORMAL);
1429                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1430                 xpt_action((union ccb *)&cgd);
1431
1432                 err_action = scsi_error_action(&ccb->csio, &cgd.inq_data,
1433                     sense_flags);
1434                 error = err_action & SS_ERRMASK;
1435
1436                 /*
1437                  * Do not autostart sequential access devices
1438                  * to avoid unexpected tape loading.
1439                  */
1440                 if ((err_action & SS_MASK) == SS_START &&
1441                     SID_TYPE(&cgd.inq_data) == T_SEQUENTIAL) {
1442                         *action_string = "Will not autostart a "
1443                             "sequential access device";
1444                         goto sense_error_done;
1445                 }
1446
1447                 /*
1448                  * Avoid recovery recursion if recovery action is the same.
1449                  */
1450                 if ((err_action & SS_MASK) >= SS_START && recoveryccb) {
1451                         if (((err_action & SS_MASK) == SS_START &&
1452                              ccb->csio.cdb_io.cdb_bytes[0] == START_STOP_UNIT) ||
1453                             ((err_action & SS_MASK) == SS_TUR &&
1454                              (ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY))) {
1455                                 err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO;
1456                                 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1457                                 *timeout = 500;
1458                         }
1459                 }
1460
1461                 /*
1462                  * If the recovery action will consume a retry,
1463                  * make sure we actually have retries available.
1464                  */
1465                 if ((err_action & SSQ_DECREMENT_COUNT) != 0) {
1466                         if (ccb->ccb_h.retry_count > 0 &&
1467                             (periph->flags & CAM_PERIPH_INVALID) == 0)
1468                                 ccb->ccb_h.retry_count--;
1469                         else {
1470                                 *action_string = "Retries exhausted";
1471                                 goto sense_error_done;
1472                         }
1473                 }
1474
1475                 if ((err_action & SS_MASK) >= SS_START) {
1476                         /*
1477                          * Do common portions of commands that
1478                          * use recovery CCBs.
1479                          */
1480                         orig_ccb = xpt_alloc_ccb_nowait();
1481                         if (orig_ccb == NULL) {
1482                                 *action_string = "Can't allocate recovery CCB";
1483                                 goto sense_error_done;
1484                         }
1485                         /*
1486                          * Clear freeze flag for original request here, as
1487                          * this freeze will be dropped as part of ERESTART.
1488                          */
1489                         ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1490                         bcopy(ccb, orig_ccb, sizeof(*orig_ccb));
1491                 }
1492
1493                 switch (err_action & SS_MASK) {
1494                 case SS_NOP:
1495                         *action_string = "No recovery action needed";
1496                         error = 0;
1497                         break;
1498                 case SS_RETRY:
1499                         *action_string = "Retrying command (per sense data)";
1500                         error = ERESTART;
1501                         break;
1502                 case SS_FAIL:
1503                         *action_string = "Unretryable error";
1504                         break;
1505                 case SS_START:
1506                 {
1507                         int le;
1508
1509                         /*
1510                          * Send a start unit command to the device, and
1511                          * then retry the command.
1512                          */
1513                         *action_string = "Attempting to start unit";
1514                         periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1515
1516                         /*
1517                          * Check for removable media and set
1518                          * load/eject flag appropriately.
1519                          */
1520                         if (SID_IS_REMOVABLE(&cgd.inq_data))
1521                                 le = TRUE;
1522                         else
1523                                 le = FALSE;
1524
1525                         scsi_start_stop(&ccb->csio,
1526                                         /*retries*/1,
1527                                         camperiphdone,
1528                                         MSG_SIMPLE_Q_TAG,
1529                                         /*start*/TRUE,
1530                                         /*load/eject*/le,
1531                                         /*immediate*/FALSE,
1532                                         SSD_FULL_SIZE,
1533                                         /*timeout*/50000);
1534                         break;
1535                 }
1536                 case SS_TUR:
1537                 {
1538                         /*
1539                          * Send a Test Unit Ready to the device.
1540                          * If the 'many' flag is set, we send 120
1541                          * test unit ready commands, one every half
1542                          * second.  Otherwise, we just send one TUR.
1543                          * We only want to do this if the retry
1544                          * count has not been exhausted.
1545                          */
1546                         int retries;
1547
1548                         if ((err_action & SSQ_MANY) != 0) {
1549                                 *action_string = "Polling device for readiness";
1550                                 retries = 120;
1551                         } else {
1552                                 *action_string = "Testing device for readiness";
1553                                 retries = 1;
1554                         }
1555                         periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1556                         scsi_test_unit_ready(&ccb->csio,
1557                                              retries,
1558                                              camperiphdone,
1559                                              MSG_SIMPLE_Q_TAG,
1560                                              SSD_FULL_SIZE,
1561                                              /*timeout*/5000);
1562
1563                         /*
1564                          * Accomplish our 500ms delay by deferring
1565                          * the release of our device queue appropriately.
1566                          */
1567                         *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1568                         *timeout = 500;
1569                         break;
1570                 }
1571                 default:
1572                         panic("Unhandled error action %x", err_action);
1573                 }
1574
1575                 if ((err_action & SS_MASK) >= SS_START) {
1576                         /*
1577                          * Drop the priority, so that the recovery
1578                          * CCB is the first to execute.  Freeze the queue
1579                          * after this command is sent so that we can
1580                          * restore the old csio and have it queued in
1581                          * the proper order before we release normal
1582                          * transactions to the device.
1583                          */
1584                         ccb->ccb_h.pinfo.priority--;
1585                         ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1586                         ccb->ccb_h.saved_ccb_ptr = orig_ccb;
1587                         error = ERESTART;
1588                         *orig = orig_ccb;
1589                 }
1590
1591 sense_error_done:
1592                 *print = ((err_action & SSQ_PRINT_SENSE) != 0);
1593         }
1594         return (error);
1595 }
1596
1597 /*
1598  * Generic error handler.  Peripheral drivers usually filter
1599  * out the errors that they handle in a unique mannor, then
1600  * call this function.
1601  */
1602 int
1603 cam_periph_error(union ccb *ccb, cam_flags camflags,
1604                  u_int32_t sense_flags, union ccb *save_ccb)
1605 {
1606         union ccb  *orig_ccb;
1607         struct cam_periph *periph;
1608         const char *action_string;
1609         cam_status  status;
1610         int         frozen, error, openings, print, lost_device;
1611         int         error_code, sense_key, asc, ascq;
1612         u_int32_t   relsim_flags, timeout;
1613
1614         print = 1;
1615         periph = xpt_path_periph(ccb->ccb_h.path);
1616         action_string = NULL;
1617         status = ccb->ccb_h.status;
1618         frozen = (status & CAM_DEV_QFRZN) != 0;
1619         status &= CAM_STATUS_MASK;
1620         openings = relsim_flags = timeout = lost_device = 0;
1621         orig_ccb = ccb;
1622
1623         switch (status) {
1624         case CAM_REQ_CMP:
1625                 error = 0;
1626                 print = 0;
1627                 break;
1628         case CAM_SCSI_STATUS_ERROR:
1629                 error = camperiphscsistatuserror(ccb, &orig_ccb,
1630                     camflags, sense_flags, &openings, &relsim_flags,
1631                     &timeout, &print, &action_string);
1632                 break;
1633         case CAM_AUTOSENSE_FAIL:
1634                 error = EIO;    /* we have to kill the command */
1635                 break;
1636         case CAM_UA_ABORT:
1637         case CAM_UA_TERMIO:
1638         case CAM_MSG_REJECT_REC:
1639                 /* XXX Don't know that these are correct */
1640                 error = EIO;
1641                 break;
1642         case CAM_SEL_TIMEOUT:
1643                 if ((camflags & CAM_RETRY_SELTO) != 0) {
1644                         if (ccb->ccb_h.retry_count > 0 &&
1645                             (periph->flags & CAM_PERIPH_INVALID) == 0) {
1646                                 ccb->ccb_h.retry_count--;
1647                                 error = ERESTART;
1648
1649                                 /*
1650                                  * Wait a bit to give the device
1651                                  * time to recover before we try again.
1652                                  */
1653                                 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1654                                 timeout = periph_selto_delay;
1655                                 break;
1656                         }
1657                         action_string = "Retries exhausted";
1658                 }
1659                 /* FALLTHROUGH */
1660         case CAM_DEV_NOT_THERE:
1661                 error = ENXIO;
1662                 print = 0;
1663                 lost_device = 1;
1664                 break;
1665         case CAM_REQ_INVALID:
1666         case CAM_PATH_INVALID:
1667         case CAM_NO_HBA:
1668         case CAM_PROVIDE_FAIL:
1669         case CAM_REQ_TOO_BIG:
1670         case CAM_LUN_INVALID:
1671         case CAM_TID_INVALID:
1672                 error = EINVAL;
1673                 break;
1674         case CAM_SCSI_BUS_RESET:
1675         case CAM_BDR_SENT:
1676                 /*
1677                  * Commands that repeatedly timeout and cause these
1678                  * kinds of error recovery actions, should return
1679                  * CAM_CMD_TIMEOUT, which allows us to safely assume
1680                  * that this command was an innocent bystander to
1681                  * these events and should be unconditionally
1682                  * retried.
1683                  */
1684         case CAM_REQUEUE_REQ:
1685                 /* Unconditional requeue if device is still there */
1686                 if (periph->flags & CAM_PERIPH_INVALID) {
1687                         action_string = "Periph was invalidated";
1688                         error = EIO;
1689                 } else if (sense_flags & SF_NO_RETRY) {
1690                         error = EIO;
1691                         action_string = "Retry was blocked";
1692                 } else {
1693                         error = ERESTART;
1694                         print = 0;
1695                 }
1696                 break;
1697         case CAM_RESRC_UNAVAIL:
1698                 /* Wait a bit for the resource shortage to abate. */
1699                 timeout = periph_noresrc_delay;
1700                 /* FALLTHROUGH */
1701         case CAM_BUSY:
1702                 if (timeout == 0) {
1703                         /* Wait a bit for the busy condition to abate. */
1704                         timeout = periph_busy_delay;
1705                 }
1706                 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1707                 /* FALLTHROUGH */
1708         case CAM_ATA_STATUS_ERROR:
1709         case CAM_REQ_CMP_ERR:
1710         case CAM_CMD_TIMEOUT:
1711         case CAM_UNEXP_BUSFREE:
1712         case CAM_UNCOR_PARITY:
1713         case CAM_DATA_RUN_ERR:
1714         default:
1715                 if (periph->flags & CAM_PERIPH_INVALID) {
1716                         error = EIO;
1717                         action_string = "Periph was invalidated";
1718                 } else if (ccb->ccb_h.retry_count == 0) {
1719                         error = EIO;
1720                         action_string = "Retries exhausted";
1721                 } else if (sense_flags & SF_NO_RETRY) {
1722                         error = EIO;
1723                         action_string = "Retry was blocked";
1724                 } else {
1725                         ccb->ccb_h.retry_count--;
1726                         error = ERESTART;
1727                 }
1728                 break;
1729         }
1730
1731         if ((sense_flags & SF_PRINT_ALWAYS) ||
1732             CAM_DEBUGGED(ccb->ccb_h.path, CAM_DEBUG_INFO))
1733                 print = 1;
1734         else if (sense_flags & SF_NO_PRINT)
1735                 print = 0;
1736         if (print)
1737                 cam_error_print(orig_ccb, CAM_ESF_ALL, CAM_EPF_ALL);
1738         if (error != 0 && print) {
1739                 if (error != ERESTART) {
1740                         if (action_string == NULL)
1741                                 action_string = "Unretryable error";
1742                         xpt_print(ccb->ccb_h.path, "Error %d, %s\n",
1743                             error, action_string);
1744                 } else if (action_string != NULL)
1745                         xpt_print(ccb->ccb_h.path, "%s\n", action_string);
1746                 else
1747                         xpt_print(ccb->ccb_h.path, "Retrying command\n");
1748         }
1749
1750         if (lost_device) {
1751                 struct cam_path *newpath;
1752                 lun_id_t lun_id;
1753
1754                 /*
1755                  * For a selection timeout, we consider all of the LUNs on
1756                  * the target to be gone.  If the status is CAM_DEV_NOT_THERE,
1757                  * then we only get rid of the device(s) specified by the
1758                  * path in the original CCB.
1759                  */
1760                 if (status == CAM_DEV_NOT_THERE)
1761                         lun_id = xpt_path_lun_id(ccb->ccb_h.path);
1762                 else
1763                         lun_id = CAM_LUN_WILDCARD;
1764
1765                 /* Should we do more if we can't create the path?? */
1766                 if (xpt_create_path(&newpath, periph,
1767                                     xpt_path_path_id(ccb->ccb_h.path),
1768                                     xpt_path_target_id(ccb->ccb_h.path),
1769                                     lun_id) == CAM_REQ_CMP) {
1770
1771                         /*
1772                          * Let peripheral drivers know that this
1773                          * device has gone away.
1774                          */
1775                         xpt_async(AC_LOST_DEVICE, newpath, NULL);
1776                         xpt_free_path(newpath);
1777                 }
1778
1779         /* Broadcast UNIT ATTENTIONs to all periphs. */
1780         } else if (scsi_extract_sense_ccb(ccb,
1781             &error_code, &sense_key, &asc, &ascq) &&
1782             sense_key == SSD_KEY_UNIT_ATTENTION) {
1783                 xpt_async(AC_UNIT_ATTENTION, orig_ccb->ccb_h.path, orig_ccb);
1784         }
1785
1786         /* Attempt a retry */
1787         if (error == ERESTART || error == 0) {
1788                 if (frozen != 0)
1789                         ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1790                 if (error == ERESTART)
1791                         xpt_action(ccb);
1792                 if (frozen != 0)
1793                         cam_release_devq(ccb->ccb_h.path,
1794                                          relsim_flags,
1795                                          openings,
1796                                          timeout,
1797                                          /*getcount_only*/0);
1798         }
1799
1800         return (error);
1801 }