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