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