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 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          * The peripheral destructor semantics dictate calling with only the
 619          * SIM mutex held.  Since it might sleep, it should not be called
 620          * with the topology lock held.
 621          */
 622         xpt_unlock_buses();
 623
 624         /*
 625          * We need to call the peripheral destructor prior to removing the
 626          * peripheral from the list.  Otherwise, we risk running into a
 627          * scenario where the peripheral unit number may get reused
 628          * (because it has been removed from the list), but some resources
 629          * used by the peripheral are still hanging around.  In particular,
 630          * the devfs nodes used by some peripherals like the pass(4) driver
 631          * aren't fully cleaned up until the destructor is run.  If the
 632          * unit number is reused before the devfs instance is fully gone,
 633          * devfs will panic.
 634          */
 635         if (periph->periph_dtor != NULL)
 636                 periph->periph_dtor(periph);
 637
 638         /*
 639          * The peripheral list is protected by the topology lock.
 640          */
 641         xpt_lock_buses();
 642
 643         TAILQ_REMOVE(&(*p_drv)->units, periph, unit_links);
 644         (*p_drv)->generation++;
 645
 646         xpt_remove_periph(periph, /*topology_lock_held*/ 1);
 647
 648         xpt_unlock_buses();
 649         CAM_DEBUG(periph->path, CAM_DEBUG_INFO, ("Periph destroyed\n"));
 650
 651         if (periph->flags & CAM_PERIPH_NEW_DEV_FOUND) {
 652                 union ccb ccb;
 653                 void *arg;
 654
 655                 switch (periph->deferred_ac) {
 656                 case AC_FOUND_DEVICE:
 657                         ccb.ccb_h.func_code = XPT_GDEV_TYPE;
 658                         xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 659                         xpt_action(&ccb);
 660                         arg = &ccb;
 661                         break;
 662                 case AC_PATH_REGISTERED:
 663                         ccb.ccb_h.func_code = XPT_PATH_INQ;
 664                         xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 665                         xpt_action(&ccb);
 666                         arg = &ccb;
 667                         break;
 668                 default:
 669                         arg = NULL;
 670                         break;
 671                 }
 672                 periph->deferred_callback(NULL, periph->deferred_ac,
 673                                           periph->path, arg);
 674         }
 675         xpt_free_path(periph->path);
 676         free(periph, M_CAMPERIPH);
 677         xpt_lock_buses();
 678 }
 679
 680 /*
 681  * Map user virtual pointers into kernel virtual address space, so we can
 682  * access the memory.  This won't work on physical pointers, for now it's
 683  * up to the caller to check for that.  (XXX KDM -- should we do that here
 684  * instead?)  This also only works for up to MAXPHYS memory.  Since we use
 685  * buffers to map stuff in and out, we're limited to the buffer size.
 686  */
 687 int
 688 cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
 689 {
 690         int numbufs, i, j;
 691         int flags[CAM_PERIPH_MAXMAPS];
 692         u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
 693         u_int32_t lengths[CAM_PERIPH_MAXMAPS];
 694         u_int32_t dirs[CAM_PERIPH_MAXMAPS];
 695         /* Some controllers may not be able to handle more data. */
 696         size_t maxmap = DFLTPHYS;
 697
 698         switch(ccb->ccb_h.func_code) {
 699         case XPT_DEV_MATCH:
 700                 if (ccb->cdm.match_buf_len == 0) {
 701                         printf("cam_periph_mapmem: invalid match buffer "
 702                                "length 0\n");
 703                         return(EINVAL);
 704                 }
 705                 if (ccb->cdm.pattern_buf_len > 0) {
 706                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
 707                         lengths[0] = ccb->cdm.pattern_buf_len;
 708                         dirs[0] = CAM_DIR_OUT;
 709                         data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
 710                         lengths[1] = ccb->cdm.match_buf_len;
 711                         dirs[1] = CAM_DIR_IN;
 712                         numbufs = 2;
 713                 } else {
 714                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
 715                         lengths[0] = ccb->cdm.match_buf_len;
 716                         dirs[0] = CAM_DIR_IN;
 717                         numbufs = 1;
 718                 }
 719                 /*
 720                  * This request will not go to the hardware, no reason
 721                  * to be so strict. vmapbuf() is able to map up to MAXPHYS.
 722                  */
 723                 maxmap = MAXPHYS;
 724                 break;
 725         case XPT_SCSI_IO:
 726         case XPT_CONT_TARGET_IO:
 727                 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
 728                         return(0);
 729
 730                 data_ptrs[0] = &ccb->csio.data_ptr;
 731                 lengths[0] = ccb->csio.dxfer_len;
 732                 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
 733                 numbufs = 1;
 734                 break;
 735         case XPT_ATA_IO:
 736                 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
 737                         return(0);
 738
 739                 data_ptrs[0] = &ccb->ataio.data_ptr;
 740                 lengths[0] = ccb->ataio.dxfer_len;
 741                 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
 742                 numbufs = 1;
 743                 break;
 744         case XPT_SMP_IO:
 745                 data_ptrs[0] = &ccb->smpio.smp_request;
 746                 lengths[0] = ccb->smpio.smp_request_len;
 747                 dirs[0] = CAM_DIR_OUT;
 748                 data_ptrs[1] = &ccb->smpio.smp_response;
 749                 lengths[1] = ccb->smpio.smp_response_len;
 750                 dirs[1] = CAM_DIR_IN;
 751                 numbufs = 2;
 752                 break;
 753         case XPT_DEV_ADVINFO:
 754                 if (ccb->cdai.bufsiz == 0)
 755                         return (0);
 756
 757                 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
 758                 lengths[0] = ccb->cdai.bufsiz;
 759                 dirs[0] = CAM_DIR_IN;
 760                 numbufs = 1;
 761
 762                 /*
 763                  * This request will not go to the hardware, no reason
 764                  * to be so strict. vmapbuf() is able to map up to MAXPHYS.
 765                  */
 766                 maxmap = MAXPHYS;
 767                 break;
 768         default:
 769                 return(EINVAL);
 770                 break; /* NOTREACHED */
 771         }
 772
 773         /*
 774          * Check the transfer length and permissions first, so we don't
 775          * have to unmap any previously mapped buffers.
 776          */
 777         for (i = 0; i < numbufs; i++) {
 778
 779                 flags[i] = 0;
 780
 781                 /*
 782                  * The userland data pointer passed in may not be page
 783                  * aligned.  vmapbuf() truncates the address to a page
 784                  * boundary, so if the address isn't page aligned, we'll
 785                  * need enough space for the given transfer length, plus
 786                  * whatever extra space is necessary to make it to the page
 787                  * boundary.
 788                  */
 789                 if ((lengths[i] +
 790                     (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)) > maxmap){
 791                         printf("cam_periph_mapmem: attempt to map %lu bytes, "
 792                                "which is greater than %lu\n",
 793                                (long)(lengths[i] +
 794                                (((vm_offset_t)(*data_ptrs[i])) & PAGE_MASK)),
 795                                (u_long)maxmap);
 796                         return(E2BIG);
 797                 }
 798
 799                 if (dirs[i] & CAM_DIR_OUT) {
 800                         flags[i] = BIO_WRITE;
 801                 }
 802
 803                 if (dirs[i] & CAM_DIR_IN) {
 804                         flags[i] = BIO_READ;
 805                 }
 806
 807         }
 808
 809         /* this keeps the current process from getting swapped */
 810         /*
 811          * XXX KDM should I use P_NOSWAP instead?
 812          */
 813         PHOLD(curproc);
 814
 815         for (i = 0; i < numbufs; i++) {
 816                 /*
 817                  * Get the buffer.
 818                  */
 819                 mapinfo->bp[i] = getpbuf(NULL);
 820
 821                 /* save the buffer's data address */
 822                 mapinfo->bp[i]->b_saveaddr = mapinfo->bp[i]->b_data;
 823
 824                 /* put our pointer in the data slot */
 825                 mapinfo->bp[i]->b_data = *data_ptrs[i];
 826
 827                 /* set the transfer length, we know it's < MAXPHYS */
 828                 mapinfo->bp[i]->b_bufsize = lengths[i];
 829
 830                 /* set the direction */
 831                 mapinfo->bp[i]->b_iocmd = flags[i];
 832
 833                 /*
 834                  * Map the buffer into kernel memory.
 835                  *
 836                  * Note that useracc() alone is not a  sufficient test.
 837                  * vmapbuf() can still fail due to a smaller file mapped
 838                  * into a larger area of VM, or if userland races against
 839                  * vmapbuf() after the useracc() check.
 840                  */
 841                 if (vmapbuf(mapinfo->bp[i]) < 0) {
 842                         for (j = 0; j < i; ++j) {
 843                                 *data_ptrs[j] = mapinfo->bp[j]->b_saveaddr;
 844                                 vunmapbuf(mapinfo->bp[j]);
 845                                 relpbuf(mapinfo->bp[j], NULL);
 846                         }
 847                         relpbuf(mapinfo->bp[i], NULL);
 848                         PRELE(curproc);
 849                         return(EACCES);
 850                 }
 851
 852                 /* set our pointer to the new mapped area */
 853                 *data_ptrs[i] = mapinfo->bp[i]->b_data;
 854
 855                 mapinfo->num_bufs_used++;
 856         }
 857
 858         /*
 859          * Now that we've gotten this far, change ownership to the kernel
 860          * of the buffers so that we don't run afoul of returning to user
 861          * space with locks (on the buffer) held.
 862          */
 863         for (i = 0; i < numbufs; i++) {
 864                 BUF_KERNPROC(mapinfo->bp[i]);
 865         }
 866
 867
 868         return(0);
 869 }
 870
 871 /*
 872  * Unmap memory segments mapped into kernel virtual address space by
 873  * cam_periph_mapmem().
 874  */
 875 void
 876 cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
 877 {
 878         int numbufs, i;
 879         u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
 880
 881         if (mapinfo->num_bufs_used <= 0) {
 882                 /* allow ourselves to be swapped once again */
 883                 PRELE(curproc);
 884                 return;
 885         }
 886
 887         switch (ccb->ccb_h.func_code) {
 888         case XPT_DEV_MATCH:
 889                 numbufs = min(mapinfo->num_bufs_used, 2);
 890
 891                 if (numbufs == 1) {
 892                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
 893                 } else {
 894                         data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
 895                         data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
 896                 }
 897                 break;
 898         case XPT_SCSI_IO:
 899         case XPT_CONT_TARGET_IO:
 900                 data_ptrs[0] = &ccb->csio.data_ptr;
 901                 numbufs = min(mapinfo->num_bufs_used, 1);
 902                 break;
 903         case XPT_ATA_IO:
 904                 data_ptrs[0] = &ccb->ataio.data_ptr;
 905                 numbufs = min(mapinfo->num_bufs_used, 1);
 906                 break;
 907         case XPT_SMP_IO:
 908                 numbufs = min(mapinfo->num_bufs_used, 2);
 909                 data_ptrs[0] = &ccb->smpio.smp_request;
 910                 data_ptrs[1] = &ccb->smpio.smp_response;
 911                 break;
 912         case XPT_DEV_ADVINFO:
 913                 numbufs = min(mapinfo->num_bufs_used, 1);
 914                 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
 915                 break;
 916         default:
 917                 /* allow ourselves to be swapped once again */
 918                 PRELE(curproc);
 919                 return;
 920                 break; /* NOTREACHED */
 921         }
 922
 923         for (i = 0; i < numbufs; i++) {
 924                 /* Set the user's pointer back to the original value */
 925                 *data_ptrs[i] = mapinfo->bp[i]->b_saveaddr;
 926
 927                 /* unmap the buffer */
 928                 vunmapbuf(mapinfo->bp[i]);
 929
 930                 /* release the buffer */
 931                 relpbuf(mapinfo->bp[i], NULL);
 932         }
 933
 934         /* allow ourselves to be swapped once again */
 935         PRELE(curproc);
 936 }
 937
 938 union ccb *
 939 cam_periph_getccb(struct cam_periph *periph, u_int32_t priority)
 940 {
 941         struct ccb_hdr *ccb_h;
 942
 943         mtx_assert(periph->sim->mtx, MA_OWNED);
 944         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("entering cdgetccb\n"));
 945
 946         while (SLIST_FIRST(&periph->ccb_list) == NULL) {
 947                 if (periph->immediate_priority > priority)
 948                         periph->immediate_priority = priority;
 949                 xpt_schedule(periph, priority);
 950                 if ((SLIST_FIRST(&periph->ccb_list) != NULL)
 951                  && (SLIST_FIRST(&periph->ccb_list)->pinfo.priority == priority))
 952                         break;
 953                 mtx_assert(periph->sim->mtx, MA_OWNED);
 954                 mtx_sleep(&periph->ccb_list, periph->sim->mtx, PRIBIO, "cgticb",
 955                     0);
 956         }
 957
 958         ccb_h = SLIST_FIRST(&periph->ccb_list);
 959         SLIST_REMOVE_HEAD(&periph->ccb_list, periph_links.sle);
 960         return ((union ccb *)ccb_h);
 961 }
 962
 963 void
 964 cam_periph_ccbwait(union ccb *ccb)
 965 {
 966         struct cam_sim *sim;
 967
 968         sim = xpt_path_sim(ccb->ccb_h.path);
 969         if ((ccb->ccb_h.pinfo.index != CAM_UNQUEUED_INDEX)
 970          || ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG))
 971                 mtx_sleep(&ccb->ccb_h.cbfcnp, sim->mtx, PRIBIO, "cbwait", 0);
 972 }
 973
 974 int
 975 cam_periph_ioctl(struct cam_periph *periph, u_long cmd, caddr_t addr,
 976                  int (*error_routine)(union ccb *ccb,
 977                                       cam_flags camflags,
 978                                       u_int32_t sense_flags))
 979 {
 980         union ccb            *ccb;
 981         int                  error;
 982         int                  found;
 983
 984         error = found = 0;
 985
 986         switch(cmd){
 987         case CAMGETPASSTHRU:
 988                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
 989                 xpt_setup_ccb(&ccb->ccb_h,
 990                               ccb->ccb_h.path,
 991                               CAM_PRIORITY_NORMAL);
 992                 ccb->ccb_h.func_code = XPT_GDEVLIST;
 993
 994                 /*
 995                  * Basically, the point of this is that we go through
 996                  * getting the list of devices, until we find a passthrough
 997                  * device.  In the current version of the CAM code, the
 998                  * only way to determine what type of device we're dealing
 999                  * with is by its name.
1000                  */
1001                 while (found == 0) {
1002                         ccb->cgdl.index = 0;
1003                         ccb->cgdl.status = CAM_GDEVLIST_MORE_DEVS;
1004                         while (ccb->cgdl.status == CAM_GDEVLIST_MORE_DEVS) {
1005
1006                                 /* we want the next device in the list */
1007                                 xpt_action(ccb);
1008                                 if (strncmp(ccb->cgdl.periph_name,
1009                                     "pass", 4) == 0){
1010                                         found = 1;
1011                                         break;
1012                                 }
1013                         }
1014                         if ((ccb->cgdl.status == CAM_GDEVLIST_LAST_DEVICE) &&
1015                             (found == 0)) {
1016                                 ccb->cgdl.periph_name[0] = '\0';
1017                                 ccb->cgdl.unit_number = 0;
1018                                 break;
1019                         }
1020                 }
1021
1022                 /* copy the result back out */
1023                 bcopy(ccb, addr, sizeof(union ccb));
1024
1025                 /* and release the ccb */
1026                 xpt_release_ccb(ccb);
1027
1028                 break;
1029         default:
1030                 error = ENOTTY;
1031                 break;
1032         }
1033         return(error);
1034 }
1035
1036 int
1037 cam_periph_runccb(union ccb *ccb,
1038                   int (*error_routine)(union ccb *ccb,
1039                                        cam_flags camflags,
1040                                        u_int32_t sense_flags),
1041                   cam_flags camflags, u_int32_t sense_flags,
1042                   struct devstat *ds)
1043 {
1044         struct cam_sim *sim;
1045         int error;
1046
1047         error = 0;
1048         sim = xpt_path_sim(ccb->ccb_h.path);
1049         mtx_assert(sim->mtx, MA_OWNED);
1050
1051         /*
1052          * If the user has supplied a stats structure, and if we understand
1053          * this particular type of ccb, record the transaction start.
1054          */
1055         if ((ds != NULL) && (ccb->ccb_h.func_code == XPT_SCSI_IO ||
1056             ccb->ccb_h.func_code == XPT_ATA_IO))
1057                 devstat_start_transaction(ds, NULL);
1058
1059         xpt_action(ccb);
1060
1061         do {
1062                 cam_periph_ccbwait(ccb);
1063                 if ((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP)
1064                         error = 0;
1065                 else if (error_routine != NULL)
1066                         error = (*error_routine)(ccb, camflags, sense_flags);
1067                 else
1068                         error = 0;
1069
1070         } while (error == ERESTART);
1071
1072         if ((ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1073                 cam_release_devq(ccb->ccb_h.path,
1074                                  /* relsim_flags */0,
1075                                  /* openings */0,
1076                                  /* timeout */0,
1077                                  /* getcount_only */ FALSE);
1078                 ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1079         }
1080
1081         if (ds != NULL) {
1082                 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
1083                         devstat_end_transaction(ds,
1084                                         ccb->csio.dxfer_len,
1085                                         ccb->csio.tag_action & 0x3,
1086                                         ((ccb->ccb_h.flags & CAM_DIR_MASK) ==
1087                                         CAM_DIR_NONE) ?  DEVSTAT_NO_DATA :
1088                                         (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1089                                         DEVSTAT_WRITE :
1090                                         DEVSTAT_READ, NULL, NULL);
1091                 } else if (ccb->ccb_h.func_code == XPT_ATA_IO) {
1092                         devstat_end_transaction(ds,
1093                                         ccb->ataio.dxfer_len,
1094                                         ccb->ataio.tag_action & 0x3,
1095                                         ((ccb->ccb_h.flags & CAM_DIR_MASK) ==
1096                                         CAM_DIR_NONE) ?  DEVSTAT_NO_DATA :
1097                                         (ccb->ccb_h.flags & CAM_DIR_OUT) ?
1098                                         DEVSTAT_WRITE :
1099                                         DEVSTAT_READ, NULL, NULL);
1100                 }
1101         }
1102
1103         return(error);
1104 }
1105
1106 void
1107 cam_freeze_devq(struct cam_path *path)
1108 {
1109
1110         cam_freeze_devq_arg(path, 0, 0);
1111 }
1112
1113 void
1114 cam_freeze_devq_arg(struct cam_path *path, uint32_t flags, uint32_t arg)
1115 {
1116         struct ccb_relsim crs;
1117
1118         xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NONE);
1119         crs.ccb_h.func_code = XPT_FREEZE_QUEUE;
1120         crs.release_flags = flags;
1121         crs.openings = arg;
1122         crs.release_timeout = arg;
1123         xpt_action((union ccb *)&crs);
1124 }
1125
1126 u_int32_t
1127 cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
1128                  u_int32_t openings, u_int32_t arg,
1129                  int getcount_only)
1130 {
1131         struct ccb_relsim crs;
1132
1133         xpt_setup_ccb(&crs.ccb_h, path, CAM_PRIORITY_NORMAL);
1134         crs.ccb_h.func_code = XPT_REL_SIMQ;
1135         crs.ccb_h.flags = getcount_only ? CAM_DEV_QFREEZE : 0;
1136         crs.release_flags = relsim_flags;
1137         crs.openings = openings;
1138         crs.release_timeout = arg;
1139         xpt_action((union ccb *)&crs);
1140         return (crs.qfrozen_cnt);
1141 }
1142
1143 #define saved_ccb_ptr ppriv_ptr0
1144 static void
1145 camperiphdone(struct cam_periph *periph, union ccb *done_ccb)
1146 {
1147         union ccb      *saved_ccb;
1148         cam_status      status;
1149         struct scsi_start_stop_unit *scsi_cmd;
1150
1151         scsi_cmd = (struct scsi_start_stop_unit *)
1152             &done_ccb->csio.cdb_io.cdb_bytes;
1153         status = done_ccb->ccb_h.status;
1154
1155         if ((status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1156                 if ((status & CAM_STATUS_MASK) == CAM_SCSI_STATUS_ERROR &&
1157                     (status & CAM_AUTOSNS_VALID)) {
1158                         struct scsi_sense_data *sense;
1159                         int    error_code, sense_key, asc, ascq, sense_len;
1160
1161                         sense = &done_ccb->csio.sense_data;
1162                         sense_len = done_ccb->csio.sense_len -
1163                                     done_ccb->csio.sense_resid;
1164                         scsi_extract_sense_len(sense, sense_len, &error_code,
1165                             &sense_key, &asc, &ascq, /*show_errors*/ 1);
1166                         /*
1167                          * If the error is "invalid field in CDB",
1168                          * and the load/eject flag is set, turn the
1169                          * flag off and try again.  This is just in
1170                          * case the drive in question barfs on the
1171                          * load eject flag.  The CAM code should set
1172                          * the load/eject flag by default for
1173                          * removable media.
1174                          */
1175                         if ((scsi_cmd->opcode == START_STOP_UNIT) &&
1176                             ((scsi_cmd->how & SSS_LOEJ) != 0) &&
1177                              (asc == 0x24) && (ascq == 0x00)) {
1178                                 scsi_cmd->how &= ~SSS_LOEJ;
1179                                 if (status & CAM_DEV_QFRZN) {
1180                                         cam_release_devq(done_ccb->ccb_h.path,
1181                                             0, 0, 0, 0);
1182                                         done_ccb->ccb_h.status &=
1183                                             ~CAM_DEV_QFRZN;
1184                                 }
1185                                 xpt_action(done_ccb);
1186                                 goto out;
1187                         }
1188                 }
1189                 if (cam_periph_error(done_ccb,
1190                     0, SF_RETRY_UA | SF_NO_PRINT, NULL) == ERESTART)
1191                         goto out;
1192                 if (done_ccb->ccb_h.status & CAM_DEV_QFRZN) {
1193                         cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1194                         done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1195                 }
1196         } else {
1197                 /*
1198                  * If we have successfully taken a device from the not
1199                  * ready to ready state, re-scan the device and re-get
1200                  * the inquiry information.  Many devices (mostly disks)
1201                  * don't properly report their inquiry information unless
1202                  * they are spun up.
1203                  */
1204                 if (scsi_cmd->opcode == START_STOP_UNIT)
1205                         xpt_async(AC_INQ_CHANGED, done_ccb->ccb_h.path, NULL);
1206         }
1207
1208         /*
1209          * Perform the final retry with the original CCB so that final
1210          * error processing is performed by the owner of the CCB.
1211          */
1212         saved_ccb = (union ccb *)done_ccb->ccb_h.saved_ccb_ptr;
1213         bcopy(saved_ccb, done_ccb, sizeof(*done_ccb));
1214         xpt_free_ccb(saved_ccb);
1215         if (done_ccb->ccb_h.cbfcnp != camperiphdone)
1216                 periph->flags &= ~CAM_PERIPH_RECOVERY_INPROG;
1217         xpt_action(done_ccb);
1218
1219 out:
1220         /* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
1221         cam_release_devq(done_ccb->ccb_h.path, 0, 0, 0, 0);
1222 }
1223
1224 /*
1225  * Generic Async Event handler.  Peripheral drivers usually
1226  * filter out the events that require personal attention,
1227  * and leave the rest to this function.
1228  */
1229 void
1230 cam_periph_async(struct cam_periph *periph, u_int32_t code,
1231                  struct cam_path *path, void *arg)
1232 {
1233         switch (code) {
1234         case AC_LOST_DEVICE:
1235                 cam_periph_invalidate(periph);
1236                 break;
1237         default:
1238                 break;
1239         }
1240 }
1241
1242 void
1243 cam_periph_bus_settle(struct cam_periph *periph, u_int bus_settle)
1244 {
1245         struct ccb_getdevstats cgds;
1246
1247         xpt_setup_ccb(&cgds.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1248         cgds.ccb_h.func_code = XPT_GDEV_STATS;
1249         xpt_action((union ccb *)&cgds);
1250         cam_periph_freeze_after_event(periph, &cgds.last_reset, bus_settle);
1251 }
1252
1253 void
1254 cam_periph_freeze_after_event(struct cam_periph *periph,
1255                               struct timeval* event_time, u_int duration_ms)
1256 {
1257         struct timeval delta;
1258         struct timeval duration_tv;
1259
1260         microtime(&delta);
1261         timevalsub(&delta, event_time);
1262         duration_tv.tv_sec = duration_ms / 1000;
1263         duration_tv.tv_usec = (duration_ms % 1000) * 1000;
1264         if (timevalcmp(&delta, &duration_tv, <)) {
1265                 timevalsub(&duration_tv, &delta);
1266
1267                 duration_ms = duration_tv.tv_sec * 1000;
1268                 duration_ms += duration_tv.tv_usec / 1000;
1269                 cam_freeze_devq(periph->path);
1270                 cam_release_devq(periph->path,
1271                                 RELSIM_RELEASE_AFTER_TIMEOUT,
1272                                 /*reduction*/0,
1273                                 /*timeout*/duration_ms,
1274                                 /*getcount_only*/0);
1275         }
1276
1277 }
1278
1279 static int
1280 camperiphscsistatuserror(union ccb *ccb, union ccb **orig_ccb,
1281     cam_flags camflags, u_int32_t sense_flags,
1282     int *openings, u_int32_t *relsim_flags,
1283     u_int32_t *timeout, int *print, const char **action_string)
1284 {
1285         int error;
1286
1287         switch (ccb->csio.scsi_status) {
1288         case SCSI_STATUS_OK:
1289         case SCSI_STATUS_COND_MET:
1290         case SCSI_STATUS_INTERMED:
1291         case SCSI_STATUS_INTERMED_COND_MET:
1292                 error = 0;
1293                 break;
1294         case SCSI_STATUS_CMD_TERMINATED:
1295         case SCSI_STATUS_CHECK_COND:
1296                 error = camperiphscsisenseerror(ccb, orig_ccb,
1297                                                 camflags,
1298                                                 sense_flags,
1299                                                 openings,
1300                                                 relsim_flags,
1301                                                 timeout,
1302                                                 print,
1303                                                 action_string);
1304                 break;
1305         case SCSI_STATUS_QUEUE_FULL:
1306         {
1307                 /* no decrement */
1308                 struct ccb_getdevstats cgds;
1309
1310                 /*
1311                  * First off, find out what the current
1312                  * transaction counts are.
1313                  */
1314                 xpt_setup_ccb(&cgds.ccb_h,
1315                               ccb->ccb_h.path,
1316                               CAM_PRIORITY_NORMAL);
1317                 cgds.ccb_h.func_code = XPT_GDEV_STATS;
1318                 xpt_action((union ccb *)&cgds);
1319
1320                 /*
1321                  * If we were the only transaction active, treat
1322                  * the QUEUE FULL as if it were a BUSY condition.
1323                  */
1324                 if (cgds.dev_active != 0) {
1325                         int total_openings;
1326
1327                         /*
1328                          * Reduce the number of openings to
1329                          * be 1 less than the amount it took
1330                          * to get a queue full bounded by the
1331                          * minimum allowed tag count for this
1332                          * device.
1333                          */
1334                         total_openings = cgds.dev_active + cgds.dev_openings;
1335                         *openings = cgds.dev_active;
1336                         if (*openings < cgds.mintags)
1337                                 *openings = cgds.mintags;
1338                         if (*openings < total_openings)
1339                                 *relsim_flags = RELSIM_ADJUST_OPENINGS;
1340                         else {
1341                                 /*
1342                                  * Some devices report queue full for
1343                                  * temporary resource shortages.  For
1344                                  * this reason, we allow a minimum
1345                                  * tag count to be entered via a
1346                                  * quirk entry to prevent the queue
1347                                  * count on these devices from falling
1348                                  * to a pessimisticly low value.  We
1349                                  * still wait for the next successful
1350                                  * completion, however, before queueing
1351                                  * more transactions to the device.
1352                                  */
1353                                 *relsim_flags = RELSIM_RELEASE_AFTER_CMDCMPLT;
1354                         }
1355                         *timeout = 0;
1356                         error = ERESTART;
1357                         *print = 0;
1358                         break;
1359                 }
1360                 /* FALLTHROUGH */
1361         }
1362         case SCSI_STATUS_BUSY:
1363                 /*
1364                  * Restart the queue after either another
1365                  * command completes or a 1 second timeout.
1366                  */
1367                 if (ccb->ccb_h.retry_count > 0) {
1368                         ccb->ccb_h.retry_count--;
1369                         error = ERESTART;
1370                         *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT
1371                                       | RELSIM_RELEASE_AFTER_CMDCMPLT;
1372                         *timeout = 1000;
1373                 } else {
1374                         error = EIO;
1375                 }
1376                 break;
1377         case SCSI_STATUS_RESERV_CONFLICT:
1378         default:
1379                 error = EIO;
1380                 break;
1381         }
1382         return (error);
1383 }
1384
1385 static int
1386 camperiphscsisenseerror(union ccb *ccb, union ccb **orig,
1387     cam_flags camflags, u_int32_t sense_flags,
1388     int *openings, u_int32_t *relsim_flags,
1389     u_int32_t *timeout, int *print, const char **action_string)
1390 {
1391         struct cam_periph *periph;
1392         union ccb *orig_ccb = ccb;
1393         int error, recoveryccb;
1394
1395         periph = xpt_path_periph(ccb->ccb_h.path);
1396         recoveryccb = (ccb->ccb_h.cbfcnp == camperiphdone);
1397         if ((periph->flags & CAM_PERIPH_RECOVERY_INPROG) && !recoveryccb) {
1398                 /*
1399                  * If error recovery is already in progress, don't attempt
1400                  * to process this error, but requeue it unconditionally
1401                  * and attempt to process it once error recovery has
1402                  * completed.  This failed command is probably related to
1403                  * the error that caused the currently active error recovery
1404                  * action so our  current recovery efforts should also
1405                  * address this command.  Be aware that the error recovery
1406                  * code assumes that only one recovery action is in progress
1407                  * on a particular peripheral instance at any given time
1408                  * (e.g. only one saved CCB for error recovery) so it is
1409                  * imperitive that we don't violate this assumption.
1410                  */
1411                 error = ERESTART;
1412                 *print = 0;
1413         } else {
1414                 scsi_sense_action err_action;
1415                 struct ccb_getdev cgd;
1416
1417                 /*
1418                  * Grab the inquiry data for this device.
1419                  */
1420                 xpt_setup_ccb(&cgd.ccb_h, ccb->ccb_h.path, CAM_PRIORITY_NORMAL);
1421                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1422                 xpt_action((union ccb *)&cgd);
1423
1424                 if ((ccb->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
1425                         err_action = scsi_error_action(&ccb->csio,
1426                                                        &cgd.inq_data,
1427                                                        sense_flags);
1428                 else
1429                         err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO;
1430                 error = err_action & SS_ERRMASK;
1431
1432                 /*
1433                  * Do not autostart sequential access devices
1434                  * to avoid unexpected tape loading.
1435                  */
1436                 if ((err_action & SS_MASK) == SS_START &&
1437                     SID_TYPE(&cgd.inq_data) == T_SEQUENTIAL) {
1438                         *action_string = "Will not autostart a "
1439                             "sequential access device";
1440                         goto sense_error_done;
1441                 }
1442
1443                 /*
1444                  * Avoid recovery recursion if recovery action is the same.
1445                  */
1446                 if ((err_action & SS_MASK) >= SS_START && recoveryccb) {
1447                         if (((err_action & SS_MASK) == SS_START &&
1448                              ccb->csio.cdb_io.cdb_bytes[0] == START_STOP_UNIT) ||
1449                             ((err_action & SS_MASK) == SS_TUR &&
1450                              (ccb->csio.cdb_io.cdb_bytes[0] == TEST_UNIT_READY))) {
1451                                 err_action = SS_RETRY|SSQ_DECREMENT_COUNT|EIO;
1452                                 *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1453                                 *timeout = 500;
1454                         }
1455                 }
1456
1457                 /*
1458                  * If the recovery action will consume a retry,
1459                  * make sure we actually have retries available.
1460                  */
1461                 if ((err_action & SSQ_DECREMENT_COUNT) != 0) {
1462                         if (ccb->ccb_h.retry_count > 0 &&
1463                             (periph->flags & CAM_PERIPH_INVALID) == 0)
1464                                 ccb->ccb_h.retry_count--;
1465                         else {
1466                                 *action_string = "Retries exhausted";
1467                                 goto sense_error_done;
1468                         }
1469                 }
1470
1471                 if ((err_action & SS_MASK) >= SS_START) {
1472                         /*
1473                          * Do common portions of commands that
1474                          * use recovery CCBs.
1475                          */
1476                         orig_ccb = xpt_alloc_ccb_nowait();
1477                         if (orig_ccb == NULL) {
1478                                 *action_string = "Can't allocate recovery CCB";
1479                                 goto sense_error_done;
1480                         }
1481                         /*
1482                          * Clear freeze flag for original request here, as
1483                          * this freeze will be dropped as part of ERESTART.
1484                          */
1485                         ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1486                         bcopy(ccb, orig_ccb, sizeof(*orig_ccb));
1487                 }
1488
1489                 switch (err_action & SS_MASK) {
1490                 case SS_NOP:
1491                         *action_string = "No recovery action needed";
1492                         error = 0;
1493                         break;
1494                 case SS_RETRY:
1495                         *action_string = "Retrying command (per sense data)";
1496                         error = ERESTART;
1497                         break;
1498                 case SS_FAIL:
1499                         *action_string = "Unretryable error";
1500                         break;
1501                 case SS_START:
1502                 {
1503                         int le;
1504
1505                         /*
1506                          * Send a start unit command to the device, and
1507                          * then retry the command.
1508                          */
1509                         *action_string = "Attempting to start unit";
1510                         periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1511
1512                         /*
1513                          * Check for removable media and set
1514                          * load/eject flag appropriately.
1515                          */
1516                         if (SID_IS_REMOVABLE(&cgd.inq_data))
1517                                 le = TRUE;
1518                         else
1519                                 le = FALSE;
1520
1521                         scsi_start_stop(&ccb->csio,
1522                                         /*retries*/1,
1523                                         camperiphdone,
1524                                         MSG_SIMPLE_Q_TAG,
1525                                         /*start*/TRUE,
1526                                         /*load/eject*/le,
1527                                         /*immediate*/FALSE,
1528                                         SSD_FULL_SIZE,
1529                                         /*timeout*/50000);
1530                         break;
1531                 }
1532                 case SS_TUR:
1533                 {
1534                         /*
1535                          * Send a Test Unit Ready to the device.
1536                          * If the 'many' flag is set, we send 120
1537                          * test unit ready commands, one every half
1538                          * second.  Otherwise, we just send one TUR.
1539                          * We only want to do this if the retry
1540                          * count has not been exhausted.
1541                          */
1542                         int retries;
1543
1544                         if ((err_action & SSQ_MANY) != 0) {
1545                                 *action_string = "Polling device for readiness";
1546                                 retries = 120;
1547                         } else {
1548                                 *action_string = "Testing device for readiness";
1549                                 retries = 1;
1550                         }
1551                         periph->flags |= CAM_PERIPH_RECOVERY_INPROG;
1552                         scsi_test_unit_ready(&ccb->csio,
1553                                              retries,
1554                                              camperiphdone,
1555                                              MSG_SIMPLE_Q_TAG,
1556                                              SSD_FULL_SIZE,
1557                                              /*timeout*/5000);
1558
1559                         /*
1560                          * Accomplish our 500ms delay by deferring
1561                          * the release of our device queue appropriately.
1562                          */
1563                         *relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1564                         *timeout = 500;
1565                         break;
1566                 }
1567                 default:
1568                         panic("Unhandled error action %x", err_action);
1569                 }
1570
1571                 if ((err_action & SS_MASK) >= SS_START) {
1572                         /*
1573                          * Drop the priority, so that the recovery
1574                          * CCB is the first to execute.  Freeze the queue
1575                          * after this command is sent so that we can
1576                          * restore the old csio and have it queued in
1577                          * the proper order before we release normal
1578                          * transactions to the device.
1579                          */
1580                         ccb->ccb_h.pinfo.priority--;
1581                         ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1582                         ccb->ccb_h.saved_ccb_ptr = orig_ccb;
1583                         error = ERESTART;
1584                         *orig = orig_ccb;
1585                 }
1586
1587 sense_error_done:
1588                 *print = ((err_action & SSQ_PRINT_SENSE) != 0);
1589         }
1590         return (error);
1591 }
1592
1593 /*
1594  * Generic error handler.  Peripheral drivers usually filter
1595  * out the errors that they handle in a unique mannor, then
1596  * call this function.
1597  */
1598 int
1599 cam_periph_error(union ccb *ccb, cam_flags camflags,
1600                  u_int32_t sense_flags, union ccb *save_ccb)
1601 {
1602         union ccb  *orig_ccb;
1603         struct cam_periph *periph;
1604         const char *action_string;
1605         cam_status  status;
1606         int         frozen, error, openings, print, lost_device;
1607         u_int32_t   relsim_flags, timeout;
1608
1609         print = 1;
1610         periph = xpt_path_periph(ccb->ccb_h.path);
1611         action_string = NULL;
1612         status = ccb->ccb_h.status;
1613         frozen = (status & CAM_DEV_QFRZN) != 0;
1614         status &= CAM_STATUS_MASK;
1615         openings = relsim_flags = timeout = lost_device = 0;
1616         orig_ccb = ccb;
1617
1618         switch (status) {
1619         case CAM_REQ_CMP:
1620                 error = 0;
1621                 print = 0;
1622                 break;
1623         case CAM_SCSI_STATUS_ERROR:
1624                 error = camperiphscsistatuserror(ccb, &orig_ccb,
1625                     camflags, sense_flags, &openings, &relsim_flags,
1626                     &timeout, &print, &action_string);
1627                 break;
1628         case CAM_AUTOSENSE_FAIL:
1629                 error = EIO;    /* we have to kill the command */
1630                 break;
1631         case CAM_UA_ABORT:
1632         case CAM_UA_TERMIO:
1633         case CAM_MSG_REJECT_REC:
1634                 /* XXX Don't know that these are correct */
1635                 error = EIO;
1636                 break;
1637         case CAM_SEL_TIMEOUT:
1638                 if ((camflags & CAM_RETRY_SELTO) != 0) {
1639                         if (ccb->ccb_h.retry_count > 0 &&
1640                             (periph->flags & CAM_PERIPH_INVALID) == 0) {
1641                                 ccb->ccb_h.retry_count--;
1642                                 error = ERESTART;
1643
1644                                 /*
1645                                  * Wait a bit to give the device
1646                                  * time to recover before we try again.
1647                                  */
1648                                 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1649                                 timeout = periph_selto_delay;
1650                                 break;
1651                         }
1652                         action_string = "Retries exhausted";
1653                 }
1654                 /* FALLTHROUGH */
1655         case CAM_DEV_NOT_THERE:
1656                 error = ENXIO;
1657                 print = 0;
1658                 lost_device = 1;
1659                 break;
1660         case CAM_REQ_INVALID:
1661         case CAM_PATH_INVALID:
1662         case CAM_NO_HBA:
1663         case CAM_PROVIDE_FAIL:
1664         case CAM_REQ_TOO_BIG:
1665         case CAM_LUN_INVALID:
1666         case CAM_TID_INVALID:
1667                 error = EINVAL;
1668                 break;
1669         case CAM_SCSI_BUS_RESET:
1670         case CAM_BDR_SENT:
1671                 /*
1672                  * Commands that repeatedly timeout and cause these
1673                  * kinds of error recovery actions, should return
1674                  * CAM_CMD_TIMEOUT, which allows us to safely assume
1675                  * that this command was an innocent bystander to
1676                  * these events and should be unconditionally
1677                  * retried.
1678                  */
1679         case CAM_REQUEUE_REQ:
1680                 /* Unconditional requeue if device is still there */
1681                 if (periph->flags & CAM_PERIPH_INVALID) {
1682                         action_string = "Periph was invalidated";
1683                         error = EIO;
1684                 } else if (sense_flags & SF_NO_RETRY) {
1685                         error = EIO;
1686                         action_string = "Retry was blocked";
1687                 } else {
1688                         error = ERESTART;
1689                         print = 0;
1690                 }
1691                 break;
1692         case CAM_RESRC_UNAVAIL:
1693                 /* Wait a bit for the resource shortage to abate. */
1694                 timeout = periph_noresrc_delay;
1695                 /* FALLTHROUGH */
1696         case CAM_BUSY:
1697                 if (timeout == 0) {
1698                         /* Wait a bit for the busy condition to abate. */
1699                         timeout = periph_busy_delay;
1700                 }
1701                 relsim_flags = RELSIM_RELEASE_AFTER_TIMEOUT;
1702                 /* FALLTHROUGH */
1703         case CAM_ATA_STATUS_ERROR:
1704         case CAM_REQ_CMP_ERR:
1705         case CAM_CMD_TIMEOUT:
1706         case CAM_UNEXP_BUSFREE:
1707         case CAM_UNCOR_PARITY:
1708         case CAM_DATA_RUN_ERR:
1709         default:
1710                 if (periph->flags & CAM_PERIPH_INVALID) {
1711                         error = EIO;
1712                         action_string = "Periph was invalidated";
1713                 } else if (ccb->ccb_h.retry_count == 0) {
1714                         error = EIO;
1715                         action_string = "Retries exhausted";
1716                 } else if (sense_flags & SF_NO_RETRY) {
1717                         error = EIO;
1718                         action_string = "Retry was blocked";
1719                 } else {
1720                         ccb->ccb_h.retry_count--;
1721                         error = ERESTART;
1722                 }
1723                 break;
1724         }
1725
1726         if ((sense_flags & SF_PRINT_ALWAYS) ||
1727             CAM_DEBUGGED(ccb->ccb_h.path, CAM_DEBUG_INFO))
1728                 print = 1;
1729         else if (sense_flags & SF_NO_PRINT)
1730                 print = 0;
1731         if (print)
1732                 cam_error_print(orig_ccb, CAM_ESF_ALL, CAM_EPF_ALL);
1733         if (error != 0 && print) {
1734                 if (error != ERESTART) {
1735                         if (action_string == NULL)
1736                                 action_string = "Unretryable error";
1737                         xpt_print(ccb->ccb_h.path, "Error %d, %s\n",
1738                             error, action_string);
1739                 } else if (action_string != NULL)
1740                         xpt_print(ccb->ccb_h.path, "%s\n", action_string);
1741                 else
1742                         xpt_print(ccb->ccb_h.path, "Retrying command\n");
1743         }
1744
1745         if (lost_device) {
1746                 struct cam_path *newpath;
1747                 lun_id_t lun_id;
1748
1749                 /*
1750                  * For a selection timeout, we consider all of the LUNs on
1751                  * the target to be gone.  If the status is CAM_DEV_NOT_THERE,
1752                  * then we only get rid of the device(s) specified by the
1753                  * path in the original CCB.
1754                  */
1755                 if (status == CAM_DEV_NOT_THERE)
1756                         lun_id = xpt_path_lun_id(ccb->ccb_h.path);
1757                 else
1758                         lun_id = CAM_LUN_WILDCARD;
1759
1760                 /* Should we do more if we can't create the path?? */
1761                 if (xpt_create_path(&newpath, periph,
1762                                     xpt_path_path_id(ccb->ccb_h.path),
1763                                     xpt_path_target_id(ccb->ccb_h.path),
1764                                     lun_id) == CAM_REQ_CMP) {
1765
1766                         /*
1767                          * Let peripheral drivers know that this
1768                          * device has gone away.
1769                          */
1770                         xpt_async(AC_LOST_DEVICE, newpath, NULL);
1771                         xpt_free_path(newpath);
1772                 }
1773         }
1774
1775         /* Attempt a retry */
1776         if (error == ERESTART || error == 0) {
1777                 if (frozen != 0)
1778                         ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
1779                 if (error == ERESTART)
1780                         xpt_action(ccb);
1781                 if (frozen != 0)
1782                         cam_release_devq(ccb->ccb_h.path,
1783                                          relsim_flags,
1784                                          openings,
1785                                          timeout,
1786                                          /*getcount_only*/0);
1787         }
1788
1789         return (error);
1790 }