1 /*- 2 * Generic SCSI Target Kernel Mode Driver 3 * 4 * Copyright (c) 2002 Nate Lawson. 5 * Copyright (c) 1998, 1999, 2001, 2002 Justin T. Gibbs. 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 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/kernel.h> 37 #include <sys/conf.h> 38 #include <sys/malloc.h> 39 #include <sys/poll.h> 40 #include <sys/vnode.h> 41 #include <sys/lock.h> 42 #include <sys/mutex.h> 43 #include <sys/devicestat.h> 44 #include <sys/proc.h> 45 /* Includes to support callout */ 46 #include <sys/types.h> 47 #include <sys/systm.h> 48 49 #include <cam/cam.h> 50 #include <cam/cam_ccb.h> 51 #include <cam/cam_periph.h> 52 #include <cam/cam_xpt_periph.h> 53 #include <cam/cam_sim.h> 54 #include <cam/scsi/scsi_targetio.h> 55 56 57 /* Transaction information attached to each CCB sent by the user */ 58 struct targ_cmd_descr { 59 struct cam_periph_map_info mapinfo; 60 TAILQ_ENTRY(targ_cmd_descr) tqe; 61 union ccb *user_ccb; 62 int priority; 63 int func_code; 64 }; 65 66 /* Offset into the private CCB area for storing our descriptor */ 67 #define targ_descr periph_priv.entries[1].ptr 68 69 TAILQ_HEAD(descr_queue, targ_cmd_descr); 70 71 typedef enum { 72 TARG_STATE_RESV = 0x00, /* Invalid state */ 73 TARG_STATE_OPENED = 0x01, /* Device opened, softc initialized */ 74 TARG_STATE_LUN_ENABLED = 0x02 /* Device enabled for a path */ 75 } targ_state; 76 77 /* Per-instance device software context */ 78 struct targ_softc { 79 /* CCBs (CTIOs, ATIOs, INOTs) pending on the controller */ 80 struct ccb_queue pending_ccb_queue; 81 82 /* Command descriptors awaiting CTIO resources from the XPT */ 83 struct descr_queue work_queue; 84 85 /* Command descriptors that have been aborted back to the user. */ 86 struct descr_queue abort_queue; 87 88 /* 89 * Queue of CCBs that have been copied out to userland, but our 90 * userland daemon has not yet seen. 91 */ 92 struct ccb_queue user_ccb_queue; 93 94 struct cam_periph *periph; 95 struct cam_path *path; 96 targ_state state; 97 struct selinfo read_select; 98 struct devstat device_stats; 99 }; 100 101 static d_open_t targopen; 102 static d_read_t targread; 103 static d_write_t targwrite; 104 static d_ioctl_t targioctl; 105 static d_poll_t targpoll; 106 static d_kqfilter_t targkqfilter; 107 static void targreadfiltdetach(struct knote *kn); 108 static int targreadfilt(struct knote *kn, long hint); 109 static struct filterops targread_filtops = { 110 .f_isfd = 1, 111 .f_detach = targreadfiltdetach, 112 .f_event = targreadfilt, 113 }; 114 115 static struct cdevsw targ_cdevsw = { 116 .d_version = D_VERSION, 117 .d_flags = D_NEEDGIANT, 118 .d_open = targopen, 119 .d_read = targread, 120 .d_write = targwrite, 121 .d_ioctl = targioctl, 122 .d_poll = targpoll, 123 .d_name = "targ", 124 .d_kqfilter = targkqfilter 125 }; 126 127 static cam_status targendislun(struct cam_path *path, int enable, 128 int grp6_len, int grp7_len); 129 static cam_status targenable(struct targ_softc *softc, 130 struct cam_path *path, 131 int grp6_len, int grp7_len); 132 static cam_status targdisable(struct targ_softc *softc); 133 static periph_ctor_t targctor; 134 static periph_dtor_t targdtor; 135 static periph_start_t targstart; 136 static int targusermerge(struct targ_softc *softc, 137 struct targ_cmd_descr *descr, 138 union ccb *ccb); 139 static int targsendccb(struct targ_softc *softc, union ccb *ccb, 140 struct targ_cmd_descr *descr); 141 static void targdone(struct cam_periph *periph, 142 union ccb *done_ccb); 143 static int targreturnccb(struct targ_softc *softc, 144 union ccb *ccb); 145 static union ccb * targgetccb(struct targ_softc *softc, xpt_opcode type, 146 int priority); 147 static void targfreeccb(struct targ_softc *softc, union ccb *ccb); 148 static struct targ_cmd_descr * 149 targgetdescr(struct targ_softc *softc); 150 static periph_init_t targinit; 151 static void targasync(void *callback_arg, u_int32_t code, 152 struct cam_path *path, void *arg); 153 static void abort_all_pending(struct targ_softc *softc); 154 static void notify_user(struct targ_softc *softc); 155 static int targcamstatus(cam_status status); 156 static size_t targccblen(xpt_opcode func_code); 157 158 static struct periph_driver targdriver = 159 { 160 targinit, "targ", 161 TAILQ_HEAD_INITIALIZER(targdriver.units), /* generation */ 0 162 }; 163 PERIPHDRIVER_DECLARE(targ, targdriver); 164 165 static MALLOC_DEFINE(M_TARG, "TARG", "TARG data"); 166 167 /* Disable LUN if enabled and teardown softc */ 168 static void 169 targcdevdtor(void *data) 170 { 171 struct targ_softc *softc; 172 struct cam_periph *periph; 173 174 softc = data; 175 if (softc->periph == NULL) { 176 printf("%s: destroying non-enabled target\n", __func__); 177 free(softc, M_TARG); 178 return; 179 } 180 181 /* 182 * Acquire a hold on the periph so that it doesn't go away before 183 * we are ready at the end of the function. 184 */ 185 periph = softc->periph; 186 cam_periph_acquire(periph); 187 cam_periph_lock(periph); 188 (void)targdisable(softc); 189 if (softc->periph != NULL) { 190 cam_periph_invalidate(softc->periph); 191 softc->periph = NULL; 192 } 193 cam_periph_unlock(periph); 194 cam_periph_release(periph); 195 free(softc, M_TARG); 196 } 197 198 /* 199 * Create softc and initialize it. There is no locking here because a 200 * periph doesn't get created until an ioctl is issued to do so, and 201 * that can't happen until this method returns. 202 */ 203 static int 204 targopen(struct cdev *dev, int flags, int fmt, struct thread *td) 205 { 206 struct targ_softc *softc; 207 208 /* Allocate its softc, initialize it */ 209 softc = malloc(sizeof(*softc), M_TARG, 210 M_WAITOK | M_ZERO); 211 softc->state = TARG_STATE_OPENED; 212 softc->periph = NULL; 213 softc->path = NULL; 214 215 TAILQ_INIT(&softc->pending_ccb_queue); 216 TAILQ_INIT(&softc->work_queue); 217 TAILQ_INIT(&softc->abort_queue); 218 TAILQ_INIT(&softc->user_ccb_queue); 219 knlist_init_mtx(&softc->read_select.si_note, NULL); 220 221 devfs_set_cdevpriv(softc, targcdevdtor); 222 return (0); 223 } 224 225 /* Enable/disable LUNs, set debugging level */ 226 static int 227 targioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td) 228 { 229 struct targ_softc *softc; 230 cam_status status; 231 232 devfs_get_cdevpriv((void **)&softc); 233 234 switch (cmd) { 235 case TARGIOCENABLE: 236 { 237 struct ioc_enable_lun *new_lun; 238 struct cam_path *path; 239 struct cam_sim *sim; 240 241 new_lun = (struct ioc_enable_lun *)addr; 242 status = xpt_create_path_unlocked(&path, /*periph*/NULL, 243 new_lun->path_id, 244 new_lun->target_id, 245 new_lun->lun_id); 246 if (status != CAM_REQ_CMP) { 247 printf("Couldn't create path, status %#x\n", status); 248 break; 249 } 250 sim = xpt_path_sim(path); 251 mtx_lock(sim->mtx); 252 status = targenable(softc, path, new_lun->grp6_len, 253 new_lun->grp7_len); 254 xpt_free_path(path); 255 mtx_unlock(sim->mtx); 256 break; 257 } 258 case TARGIOCDISABLE: 259 if (softc->periph == NULL) { 260 status = CAM_DEV_NOT_THERE; 261 break; 262 } 263 cam_periph_lock(softc->periph); 264 status = targdisable(softc); 265 cam_periph_unlock(softc->periph); 266 break; 267 case TARGIOCDEBUG: 268 { 269 struct ccb_debug cdbg; 270 271 /* If no periph available, disallow debugging changes */ 272 if ((softc->state & TARG_STATE_LUN_ENABLED) == 0) { 273 status = CAM_DEV_NOT_THERE; 274 break; 275 } 276 bzero(&cdbg, sizeof cdbg); 277 if (*((int *)addr) != 0) 278 cdbg.flags = CAM_DEBUG_PERIPH; 279 else 280 cdbg.flags = CAM_DEBUG_NONE; 281 cam_periph_lock(softc->periph); 282 xpt_setup_ccb(&cdbg.ccb_h, softc->path, CAM_PRIORITY_NORMAL); 283 cdbg.ccb_h.func_code = XPT_DEBUG; 284 cdbg.ccb_h.cbfcnp = targdone; 285 286 xpt_action((union ccb *)&cdbg); 287 cam_periph_unlock(softc->periph); 288 status = cdbg.ccb_h.status & CAM_STATUS_MASK; 289 break; 290 } 291 default: 292 status = CAM_PROVIDE_FAIL; 293 break; 294 } 295 296 return (targcamstatus(status)); 297 } 298 299 /* Writes are always ready, reads wait for user_ccb_queue or abort_queue */ 300 static int 301 targpoll(struct cdev *dev, int poll_events, struct thread *td) 302 { 303 struct targ_softc *softc; 304 int revents; 305 306 devfs_get_cdevpriv((void **)&softc); 307 308 /* Poll for write() is always ok. */ 309 revents = poll_events & (POLLOUT | POLLWRNORM); 310 if ((poll_events & (POLLIN | POLLRDNORM)) != 0) { 311 /* Poll for read() depends on user and abort queues. */ 312 cam_periph_lock(softc->periph); 313 if (!TAILQ_EMPTY(&softc->user_ccb_queue) || 314 !TAILQ_EMPTY(&softc->abort_queue)) { 315 revents |= poll_events & (POLLIN | POLLRDNORM); 316 } 317 cam_periph_unlock(softc->periph); 318 /* Only sleep if the user didn't poll for write. */ 319 if (revents == 0) 320 selrecord(td, &softc->read_select); 321 } 322 323 return (revents); 324 } 325 326 static int 327 targkqfilter(struct cdev *dev, struct knote *kn) 328 { 329 struct targ_softc *softc; 330 331 devfs_get_cdevpriv((void **)&softc); 332 kn->kn_hook = (caddr_t)softc; 333 kn->kn_fop = &targread_filtops; 334 knlist_add(&softc->read_select.si_note, kn, 0); 335 return (0); 336 } 337 338 static void 339 targreadfiltdetach(struct knote *kn) 340 { 341 struct targ_softc *softc; 342 343 softc = (struct targ_softc *)kn->kn_hook; 344 knlist_remove(&softc->read_select.si_note, kn, 0); 345 } 346 347 /* Notify the user's kqueue when the user queue or abort queue gets a CCB */ 348 static int 349 targreadfilt(struct knote *kn, long hint) 350 { 351 struct targ_softc *softc; 352 int retval; 353 354 softc = (struct targ_softc *)kn->kn_hook; 355 cam_periph_lock(softc->periph); 356 retval = !TAILQ_EMPTY(&softc->user_ccb_queue) || 357 !TAILQ_EMPTY(&softc->abort_queue); 358 cam_periph_unlock(softc->periph); 359 return (retval); 360 } 361 362 /* Send the HBA the enable/disable message */ 363 static cam_status 364 targendislun(struct cam_path *path, int enable, int grp6_len, int grp7_len) 365 { 366 struct ccb_en_lun en_ccb; 367 cam_status status; 368 369 /* Tell the lun to begin answering selects */ 370 xpt_setup_ccb(&en_ccb.ccb_h, path, CAM_PRIORITY_NORMAL); 371 en_ccb.ccb_h.func_code = XPT_EN_LUN; 372 /* Don't need support for any vendor specific commands */ 373 en_ccb.grp6_len = grp6_len; 374 en_ccb.grp7_len = grp7_len; 375 en_ccb.enable = enable ? 1 : 0; 376 xpt_action((union ccb *)&en_ccb); 377 status = en_ccb.ccb_h.status & CAM_STATUS_MASK; 378 if (status != CAM_REQ_CMP) { 379 xpt_print(path, "%sable lun CCB rejected, status %#x\n", 380 enable ? "en" : "dis", status); 381 } 382 return (status); 383 } 384 385 /* Enable target mode on a LUN, given its path */ 386 static cam_status 387 targenable(struct targ_softc *softc, struct cam_path *path, int grp6_len, 388 int grp7_len) 389 { 390 struct cam_periph *periph; 391 struct ccb_pathinq cpi; 392 cam_status status; 393 394 if ((softc->state & TARG_STATE_LUN_ENABLED) != 0) 395 return (CAM_LUN_ALRDY_ENA); 396 397 /* Make sure SIM supports target mode */ 398 xpt_setup_ccb(&cpi.ccb_h, path, CAM_PRIORITY_NORMAL); 399 cpi.ccb_h.func_code = XPT_PATH_INQ; 400 xpt_action((union ccb *)&cpi); 401 status = cpi.ccb_h.status & CAM_STATUS_MASK; 402 if (status != CAM_REQ_CMP) { 403 printf("pathinq failed, status %#x\n", status); 404 goto enable_fail; 405 } 406 if ((cpi.target_sprt & PIT_PROCESSOR) == 0) { 407 printf("controller does not support target mode\n"); 408 status = CAM_FUNC_NOTAVAIL; 409 goto enable_fail; 410 } 411 412 /* Destroy any periph on our path if it is disabled */ 413 periph = cam_periph_find(path, "targ"); 414 if (periph != NULL) { 415 struct targ_softc *del_softc; 416 417 del_softc = (struct targ_softc *)periph->softc; 418 if ((del_softc->state & TARG_STATE_LUN_ENABLED) == 0) { 419 cam_periph_invalidate(del_softc->periph); 420 del_softc->periph = NULL; 421 } else { 422 printf("Requested path still in use by targ%d\n", 423 periph->unit_number); 424 status = CAM_LUN_ALRDY_ENA; 425 goto enable_fail; 426 } 427 } 428 429 /* Create a periph instance attached to this path */ 430 status = cam_periph_alloc(targctor, NULL, targdtor, targstart, 431 "targ", CAM_PERIPH_BIO, path, targasync, 0, softc); 432 if (status != CAM_REQ_CMP) { 433 printf("cam_periph_alloc failed, status %#x\n", status); 434 goto enable_fail; 435 } 436 437 /* Ensure that the periph now exists. */ 438 if (cam_periph_find(path, "targ") == NULL) { 439 panic("targenable: succeeded but no periph?"); 440 /* NOTREACHED */ 441 } 442 443 /* Send the enable lun message */ 444 status = targendislun(path, /*enable*/1, grp6_len, grp7_len); 445 if (status != CAM_REQ_CMP) { 446 printf("enable lun failed, status %#x\n", status); 447 goto enable_fail; 448 } 449 softc->state |= TARG_STATE_LUN_ENABLED; 450 451 enable_fail: 452 return (status); 453 } 454 455 /* Disable this softc's target instance if enabled */ 456 static cam_status 457 targdisable(struct targ_softc *softc) 458 { 459 cam_status status; 460 461 if ((softc->state & TARG_STATE_LUN_ENABLED) == 0) 462 return (CAM_REQ_CMP); 463 464 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targdisable\n")); 465 466 /* Abort any ccbs pending on the controller */ 467 abort_all_pending(softc); 468 469 /* Disable this lun */ 470 status = targendislun(softc->path, /*enable*/0, 471 /*grp6_len*/0, /*grp7_len*/0); 472 if (status == CAM_REQ_CMP) 473 softc->state &= ~TARG_STATE_LUN_ENABLED; 474 else 475 printf("Disable lun failed, status %#x\n", status); 476 477 return (status); 478 } 479 480 /* Initialize a periph (called from cam_periph_alloc) */ 481 static cam_status 482 targctor(struct cam_periph *periph, void *arg) 483 { 484 struct targ_softc *softc; 485 486 /* Store pointer to softc for periph-driven routines */ 487 softc = (struct targ_softc *)arg; 488 periph->softc = softc; 489 softc->periph = periph; 490 softc->path = periph->path; 491 return (CAM_REQ_CMP); 492 } 493 494 static void 495 targdtor(struct cam_periph *periph) 496 { 497 struct targ_softc *softc; 498 struct ccb_hdr *ccb_h; 499 struct targ_cmd_descr *descr; 500 501 softc = (struct targ_softc *)periph->softc; 502 503 /* 504 * targdisable() aborts CCBs back to the user and leaves them 505 * on user_ccb_queue and abort_queue in case the user is still 506 * interested in them. We free them now. 507 */ 508 while ((ccb_h = TAILQ_FIRST(&softc->user_ccb_queue)) != NULL) { 509 TAILQ_REMOVE(&softc->user_ccb_queue, ccb_h, periph_links.tqe); 510 targfreeccb(softc, (union ccb *)ccb_h); 511 } 512 while ((descr = TAILQ_FIRST(&softc->abort_queue)) != NULL) { 513 TAILQ_REMOVE(&softc->abort_queue, descr, tqe); 514 free(descr, M_TARG); 515 } 516 517 softc->periph = NULL; 518 softc->path = NULL; 519 periph->softc = NULL; 520 } 521 522 /* Receive CCBs from user mode proc and send them to the HBA */ 523 static int 524 targwrite(struct cdev *dev, struct uio *uio, int ioflag) 525 { 526 union ccb *user_ccb; 527 struct targ_softc *softc; 528 struct targ_cmd_descr *descr; 529 int write_len, error; 530 int func_code, priority; 531 532 devfs_get_cdevpriv((void **)&softc); 533 write_len = error = 0; 534 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 535 ("write - uio_resid %zd\n", uio->uio_resid)); 536 while (uio->uio_resid >= sizeof(user_ccb) && error == 0) { 537 union ccb *ccb; 538 539 error = uiomove((caddr_t)&user_ccb, sizeof(user_ccb), uio); 540 if (error != 0) { 541 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 542 ("write - uiomove failed (%d)\n", error)); 543 break; 544 } 545 priority = fuword32(&user_ccb->ccb_h.pinfo.priority); 546 if (priority == CAM_PRIORITY_NONE) { 547 error = EINVAL; 548 break; 549 } 550 func_code = fuword32(&user_ccb->ccb_h.func_code); 551 switch (func_code) { 552 case XPT_ACCEPT_TARGET_IO: 553 case XPT_IMMED_NOTIFY: 554 cam_periph_lock(softc->periph); 555 ccb = targgetccb(softc, func_code, priority); 556 descr = (struct targ_cmd_descr *)ccb->ccb_h.targ_descr; 557 descr->user_ccb = user_ccb; 558 descr->func_code = func_code; 559 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 560 ("Sent ATIO/INOT (%p)\n", user_ccb)); 561 xpt_action(ccb); 562 TAILQ_INSERT_TAIL(&softc->pending_ccb_queue, 563 &ccb->ccb_h, 564 periph_links.tqe); 565 cam_periph_unlock(softc->periph); 566 break; 567 default: 568 cam_periph_lock(softc->periph); 569 if ((func_code & XPT_FC_QUEUED) != 0) { 570 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 571 ("Sending queued ccb %#x (%p)\n", 572 func_code, user_ccb)); 573 descr = targgetdescr(softc); 574 descr->user_ccb = user_ccb; 575 descr->priority = priority; 576 descr->func_code = func_code; 577 TAILQ_INSERT_TAIL(&softc->work_queue, 578 descr, tqe); 579 xpt_schedule(softc->periph, priority); 580 } else { 581 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 582 ("Sending inline ccb %#x (%p)\n", 583 func_code, user_ccb)); 584 ccb = targgetccb(softc, func_code, priority); 585 descr = (struct targ_cmd_descr *) 586 ccb->ccb_h.targ_descr; 587 descr->user_ccb = user_ccb; 588 descr->priority = priority; 589 descr->func_code = func_code; 590 if (targusermerge(softc, descr, ccb) != EFAULT) 591 targsendccb(softc, ccb, descr); 592 targreturnccb(softc, ccb); 593 } 594 cam_periph_unlock(softc->periph); 595 break; 596 } 597 write_len += sizeof(user_ccb); 598 } 599 600 /* 601 * If we've successfully taken in some amount of 602 * data, return success for that data first. If 603 * an error is persistent, it will be reported 604 * on the next write. 605 */ 606 if (error != 0 && write_len == 0) 607 return (error); 608 if (write_len == 0 && uio->uio_resid != 0) 609 return (ENOSPC); 610 return (0); 611 } 612 613 /* Process requests (descrs) via the periph-supplied CCBs */ 614 static void 615 targstart(struct cam_periph *periph, union ccb *start_ccb) 616 { 617 struct targ_softc *softc; 618 struct targ_cmd_descr *descr, *next_descr; 619 int error; 620 621 softc = (struct targ_softc *)periph->softc; 622 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targstart %p\n", start_ccb)); 623 624 descr = TAILQ_FIRST(&softc->work_queue); 625 if (descr == NULL) { 626 xpt_release_ccb(start_ccb); 627 } else { 628 TAILQ_REMOVE(&softc->work_queue, descr, tqe); 629 next_descr = TAILQ_FIRST(&softc->work_queue); 630 631 /* Initiate a transaction using the descr and supplied CCB */ 632 error = targusermerge(softc, descr, start_ccb); 633 if (error == 0) 634 error = targsendccb(softc, start_ccb, descr); 635 if (error != 0) { 636 xpt_print(periph->path, 637 "targsendccb failed, err %d\n", error); 638 xpt_release_ccb(start_ccb); 639 suword(&descr->user_ccb->ccb_h.status, 640 CAM_REQ_CMP_ERR); 641 TAILQ_INSERT_TAIL(&softc->abort_queue, descr, tqe); 642 notify_user(softc); 643 } 644 645 /* If we have more work to do, stay scheduled */ 646 if (next_descr != NULL) 647 xpt_schedule(periph, next_descr->priority); 648 } 649 } 650 651 static int 652 targusermerge(struct targ_softc *softc, struct targ_cmd_descr *descr, 653 union ccb *ccb) 654 { 655 struct ccb_hdr *u_ccbh, *k_ccbh; 656 size_t ccb_len; 657 int error; 658 659 u_ccbh = &descr->user_ccb->ccb_h; 660 k_ccbh = &ccb->ccb_h; 661 662 /* 663 * There are some fields in the CCB header that need to be 664 * preserved, the rest we get from the user ccb. (See xpt_merge_ccb) 665 */ 666 xpt_setup_ccb(k_ccbh, softc->path, descr->priority); 667 k_ccbh->retry_count = fuword32(&u_ccbh->retry_count); 668 k_ccbh->func_code = descr->func_code; 669 k_ccbh->flags = fuword32(&u_ccbh->flags); 670 k_ccbh->timeout = fuword32(&u_ccbh->timeout); 671 ccb_len = targccblen(k_ccbh->func_code) - sizeof(struct ccb_hdr); 672 error = copyin(u_ccbh + 1, k_ccbh + 1, ccb_len); 673 if (error != 0) { 674 k_ccbh->status = CAM_REQ_CMP_ERR; 675 return (error); 676 } 677 678 /* Translate usermode abort_ccb pointer to its kernel counterpart */ 679 if (k_ccbh->func_code == XPT_ABORT) { 680 struct ccb_abort *cab; 681 struct ccb_hdr *ccb_h; 682 683 cab = (struct ccb_abort *)ccb; 684 TAILQ_FOREACH(ccb_h, &softc->pending_ccb_queue, 685 periph_links.tqe) { 686 struct targ_cmd_descr *ab_descr; 687 688 ab_descr = (struct targ_cmd_descr *)ccb_h->targ_descr; 689 if (ab_descr->user_ccb == cab->abort_ccb) { 690 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 691 ("Changing abort for %p to %p\n", 692 cab->abort_ccb, ccb_h)); 693 cab->abort_ccb = (union ccb *)ccb_h; 694 break; 695 } 696 } 697 /* CCB not found, set appropriate status */ 698 if (ccb_h == NULL) { 699 k_ccbh->status = CAM_PATH_INVALID; 700 error = ESRCH; 701 } 702 } 703 704 return (error); 705 } 706 707 /* Build and send a kernel CCB formed from descr->user_ccb */ 708 static int 709 targsendccb(struct targ_softc *softc, union ccb *ccb, 710 struct targ_cmd_descr *descr) 711 { 712 struct cam_periph_map_info *mapinfo; 713 struct ccb_hdr *ccb_h; 714 int error; 715 716 ccb_h = &ccb->ccb_h; 717 mapinfo = &descr->mapinfo; 718 mapinfo->num_bufs_used = 0; 719 720 /* 721 * There's no way for the user to have a completion 722 * function, so we put our own completion function in here. 723 * We also stash in a reference to our descriptor so targreturnccb() 724 * can find our mapping info. 725 */ 726 ccb_h->cbfcnp = targdone; 727 ccb_h->targ_descr = descr; 728 729 if ((ccb_h->func_code == XPT_CONT_TARGET_IO) || 730 (ccb_h->func_code == XPT_DEV_MATCH)) { 731 732 error = cam_periph_mapmem(ccb, mapinfo); 733 734 /* 735 * cam_periph_mapmem returned an error, we can't continue. 736 * Return the error to the user. 737 */ 738 if (error) { 739 ccb_h->status = CAM_REQ_CMP_ERR; 740 mapinfo->num_bufs_used = 0; 741 return (error); 742 } 743 } 744 745 /* 746 * Once queued on the pending CCB list, this CCB will be protected 747 * by our error recovery handler. 748 */ 749 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("sendccb %p\n", ccb)); 750 if (XPT_FC_IS_QUEUED(ccb)) { 751 TAILQ_INSERT_TAIL(&softc->pending_ccb_queue, ccb_h, 752 periph_links.tqe); 753 } 754 xpt_action(ccb); 755 756 return (0); 757 } 758 759 /* Completion routine for CCBs (called at splsoftcam) */ 760 static void 761 targdone(struct cam_periph *periph, union ccb *done_ccb) 762 { 763 struct targ_softc *softc; 764 cam_status status; 765 766 CAM_DEBUG(periph->path, CAM_DEBUG_PERIPH, ("targdone %p\n", done_ccb)); 767 softc = (struct targ_softc *)periph->softc; 768 TAILQ_REMOVE(&softc->pending_ccb_queue, &done_ccb->ccb_h, 769 periph_links.tqe); 770 status = done_ccb->ccb_h.status & CAM_STATUS_MASK; 771 772 /* If we're no longer enabled, throw away CCB */ 773 if ((softc->state & TARG_STATE_LUN_ENABLED) == 0) { 774 targfreeccb(softc, done_ccb); 775 return; 776 } 777 /* abort_all_pending() waits for pending queue to be empty */ 778 if (TAILQ_EMPTY(&softc->pending_ccb_queue)) 779 wakeup(&softc->pending_ccb_queue); 780 781 switch (done_ccb->ccb_h.func_code) { 782 /* All FC_*_QUEUED CCBs go back to userland */ 783 case XPT_IMMED_NOTIFY: 784 case XPT_ACCEPT_TARGET_IO: 785 case XPT_CONT_TARGET_IO: 786 TAILQ_INSERT_TAIL(&softc->user_ccb_queue, &done_ccb->ccb_h, 787 periph_links.tqe); 788 cam_periph_unlock(softc->periph); 789 notify_user(softc); 790 cam_periph_lock(softc->periph); 791 break; 792 default: 793 panic("targdone: impossible xpt opcode %#x", 794 done_ccb->ccb_h.func_code); 795 /* NOTREACHED */ 796 } 797 } 798 799 /* Return CCBs to the user from the user queue and abort queue */ 800 static int 801 targread(struct cdev *dev, struct uio *uio, int ioflag) 802 { 803 struct descr_queue *abort_queue; 804 struct targ_cmd_descr *user_descr; 805 struct targ_softc *softc; 806 struct ccb_queue *user_queue; 807 struct ccb_hdr *ccb_h; 808 union ccb *user_ccb; 809 int read_len, error; 810 811 error = 0; 812 read_len = 0; 813 devfs_get_cdevpriv((void **)&softc); 814 user_queue = &softc->user_ccb_queue; 815 abort_queue = &softc->abort_queue; 816 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targread\n")); 817 818 /* If no data is available, wait or return immediately */ 819 cam_periph_lock(softc->periph); 820 ccb_h = TAILQ_FIRST(user_queue); 821 user_descr = TAILQ_FIRST(abort_queue); 822 while (ccb_h == NULL && user_descr == NULL) { 823 if ((ioflag & IO_NDELAY) == 0) { 824 error = msleep(user_queue, softc->periph->sim->mtx, 825 PRIBIO | PCATCH, "targrd", 0); 826 ccb_h = TAILQ_FIRST(user_queue); 827 user_descr = TAILQ_FIRST(abort_queue); 828 if (error != 0) { 829 if (error == ERESTART) { 830 continue; 831 } else { 832 goto read_fail; 833 } 834 } 835 } else { 836 cam_periph_unlock(softc->periph); 837 return (EAGAIN); 838 } 839 } 840 841 /* Data is available so fill the user's buffer */ 842 while (ccb_h != NULL) { 843 struct targ_cmd_descr *descr; 844 845 if (uio->uio_resid < sizeof(user_ccb)) 846 break; 847 TAILQ_REMOVE(user_queue, ccb_h, periph_links.tqe); 848 descr = (struct targ_cmd_descr *)ccb_h->targ_descr; 849 user_ccb = descr->user_ccb; 850 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 851 ("targread ccb %p (%p)\n", ccb_h, user_ccb)); 852 error = targreturnccb(softc, (union ccb *)ccb_h); 853 if (error != 0) 854 goto read_fail; 855 cam_periph_unlock(softc->periph); 856 error = uiomove((caddr_t)&user_ccb, sizeof(user_ccb), uio); 857 cam_periph_lock(softc->periph); 858 if (error != 0) 859 goto read_fail; 860 read_len += sizeof(user_ccb); 861 862 ccb_h = TAILQ_FIRST(user_queue); 863 } 864 865 /* Flush out any aborted descriptors */ 866 while (user_descr != NULL) { 867 if (uio->uio_resid < sizeof(user_ccb)) 868 break; 869 TAILQ_REMOVE(abort_queue, user_descr, tqe); 870 user_ccb = user_descr->user_ccb; 871 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 872 ("targread aborted descr %p (%p)\n", 873 user_descr, user_ccb)); 874 suword(&user_ccb->ccb_h.status, CAM_REQ_ABORTED); 875 cam_periph_unlock(softc->periph); 876 error = uiomove((caddr_t)&user_ccb, sizeof(user_ccb), uio); 877 cam_periph_lock(softc->periph); 878 if (error != 0) 879 goto read_fail; 880 read_len += sizeof(user_ccb); 881 882 user_descr = TAILQ_FIRST(abort_queue); 883 } 884 885 /* 886 * If we've successfully read some amount of data, don't report an 887 * error. If the error is persistent, it will be reported on the 888 * next read(). 889 */ 890 if (read_len == 0 && uio->uio_resid != 0) 891 error = ENOSPC; 892 893 read_fail: 894 cam_periph_unlock(softc->periph); 895 return (error); 896 } 897 898 /* Copy completed ccb back to the user */ 899 static int 900 targreturnccb(struct targ_softc *softc, union ccb *ccb) 901 { 902 struct targ_cmd_descr *descr; 903 struct ccb_hdr *u_ccbh; 904 size_t ccb_len; 905 int error; 906 907 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targreturnccb %p\n", ccb)); 908 descr = (struct targ_cmd_descr *)ccb->ccb_h.targ_descr; 909 u_ccbh = &descr->user_ccb->ccb_h; 910 911 /* Copy out the central portion of the ccb_hdr */ 912 copyout(&ccb->ccb_h.retry_count, &u_ccbh->retry_count, 913 offsetof(struct ccb_hdr, periph_priv) - 914 offsetof(struct ccb_hdr, retry_count)); 915 916 /* Copy out the rest of the ccb (after the ccb_hdr) */ 917 ccb_len = targccblen(ccb->ccb_h.func_code) - sizeof(struct ccb_hdr); 918 if (descr->mapinfo.num_bufs_used != 0) 919 cam_periph_unmapmem(ccb, &descr->mapinfo); 920 error = copyout(&ccb->ccb_h + 1, u_ccbh + 1, ccb_len); 921 if (error != 0) { 922 xpt_print(softc->path, 923 "targreturnccb - CCB copyout failed (%d)\n", error); 924 } 925 /* Free CCB or send back to devq. */ 926 targfreeccb(softc, ccb); 927 928 return (error); 929 } 930 931 static union ccb * 932 targgetccb(struct targ_softc *softc, xpt_opcode type, int priority) 933 { 934 union ccb *ccb; 935 int ccb_len; 936 937 ccb_len = targccblen(type); 938 ccb = malloc(ccb_len, M_TARG, M_NOWAIT); 939 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("getccb %p\n", ccb)); 940 if (ccb == NULL) { 941 return (ccb); 942 } 943 xpt_setup_ccb(&ccb->ccb_h, softc->path, priority); 944 ccb->ccb_h.func_code = type; 945 ccb->ccb_h.cbfcnp = targdone; 946 ccb->ccb_h.targ_descr = targgetdescr(softc); 947 if (ccb->ccb_h.targ_descr == NULL) { 948 free (ccb, M_TARG); 949 ccb = NULL; 950 } 951 return (ccb); 952 } 953 954 static void 955 targfreeccb(struct targ_softc *softc, union ccb *ccb) 956 { 957 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH, ("targfreeccb descr %p and\n", 958 ccb->ccb_h.targ_descr)); 959 free(ccb->ccb_h.targ_descr, M_TARG); 960 961 switch (ccb->ccb_h.func_code) { 962 case XPT_ACCEPT_TARGET_IO: 963 case XPT_IMMED_NOTIFY: 964 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH, ("freeing ccb %p\n", ccb)); 965 free(ccb, M_TARG); 966 break; 967 default: 968 /* Send back CCB if we got it from the periph */ 969 if (XPT_FC_IS_QUEUED(ccb)) { 970 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH, 971 ("returning queued ccb %p\n", ccb)); 972 xpt_release_ccb(ccb); 973 } else { 974 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH, 975 ("freeing ccb %p\n", ccb)); 976 free(ccb, M_TARG); 977 } 978 break; 979 } 980 } 981 982 static struct targ_cmd_descr * 983 targgetdescr(struct targ_softc *softc) 984 { 985 struct targ_cmd_descr *descr; 986 987 descr = malloc(sizeof(*descr), M_TARG, 988 M_NOWAIT); 989 if (descr) { 990 descr->mapinfo.num_bufs_used = 0; 991 } 992 return (descr); 993 } 994 995 static void 996 targinit(void) 997 { 998 struct cdev *dev; 999 1000 /* Add symbolic link to targ0 for compatibility. */ 1001 dev = make_dev(&targ_cdevsw, 0, UID_ROOT, GID_WHEEL, 0600, "targ"); 1002 make_dev_alias(dev, "targ0"); 1003 } 1004 1005 static void 1006 targasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg) 1007 { 1008 /* All events are handled in usermode by INOTs */ 1009 panic("targasync() called, should be an INOT instead"); 1010 } 1011 1012 /* Cancel all pending requests and CCBs awaiting work. */ 1013 static void 1014 abort_all_pending(struct targ_softc *softc) 1015 { 1016 struct targ_cmd_descr *descr; 1017 struct ccb_abort cab; 1018 struct ccb_hdr *ccb_h; 1019 struct cam_sim *sim; 1020 1021 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("abort_all_pending\n")); 1022 1023 /* First abort the descriptors awaiting resources */ 1024 while ((descr = TAILQ_FIRST(&softc->work_queue)) != NULL) { 1025 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 1026 ("Aborting descr from workq %p\n", descr)); 1027 TAILQ_REMOVE(&softc->work_queue, descr, tqe); 1028 TAILQ_INSERT_TAIL(&softc->abort_queue, descr, tqe); 1029 } 1030 1031 /* 1032 * Then abort all pending CCBs. 1033 * targdone() will return the aborted CCB via user_ccb_queue 1034 */ 1035 xpt_setup_ccb(&cab.ccb_h, softc->path, CAM_PRIORITY_NORMAL); 1036 cab.ccb_h.func_code = XPT_ABORT; 1037 cab.ccb_h.status = CAM_REQ_CMP_ERR; 1038 TAILQ_FOREACH(ccb_h, &softc->pending_ccb_queue, periph_links.tqe) { 1039 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, 1040 ("Aborting pending CCB %p\n", ccb_h)); 1041 cab.abort_ccb = (union ccb *)ccb_h; 1042 xpt_action((union ccb *)&cab); 1043 if (cab.ccb_h.status != CAM_REQ_CMP) { 1044 xpt_print(cab.ccb_h.path, 1045 "Unable to abort CCB, status %#x\n", 1046 cab.ccb_h.status); 1047 } 1048 } 1049 1050 /* If we aborted at least one pending CCB ok, wait for it. */ 1051 if (cab.ccb_h.status == CAM_REQ_CMP) { 1052 sim = xpt_path_sim(softc->path); 1053 msleep(&softc->pending_ccb_queue, sim->mtx, 1054 PRIBIO | PCATCH, "tgabrt", 0); 1055 } 1056 1057 /* If we aborted anything from the work queue, wakeup user. */ 1058 if (!TAILQ_EMPTY(&softc->user_ccb_queue) 1059 || !TAILQ_EMPTY(&softc->abort_queue)) { 1060 cam_periph_unlock(softc->periph); 1061 notify_user(softc); 1062 cam_periph_lock(softc->periph); 1063 } 1064 } 1065 1066 /* Notify the user that data is ready */ 1067 static void 1068 notify_user(struct targ_softc *softc) 1069 { 1070 /* 1071 * Notify users sleeping via poll(), kqueue(), and 1072 * blocking read(). 1073 */ 1074 selwakeuppri(&softc->read_select, PRIBIO); 1075 KNOTE_UNLOCKED(&softc->read_select.si_note, 0); 1076 wakeup(&softc->user_ccb_queue); 1077 } 1078 1079 /* Convert CAM status to errno values */ 1080 static int 1081 targcamstatus(cam_status status) 1082 { 1083 switch (status & CAM_STATUS_MASK) { 1084 case CAM_REQ_CMP: /* CCB request completed without error */ 1085 return (0); 1086 case CAM_REQ_INPROG: /* CCB request is in progress */ 1087 return (EINPROGRESS); 1088 case CAM_REQ_CMP_ERR: /* CCB request completed with an error */ 1089 return (EIO); 1090 case CAM_PROVIDE_FAIL: /* Unable to provide requested capability */ 1091 return (ENOTTY); 1092 case CAM_FUNC_NOTAVAIL: /* The requested function is not available */ 1093 return (ENOTSUP); 1094 case CAM_LUN_ALRDY_ENA: /* LUN is already enabled for target mode */ 1095 return (EADDRINUSE); 1096 case CAM_PATH_INVALID: /* Supplied Path ID is invalid */ 1097 case CAM_DEV_NOT_THERE: /* SCSI Device Not Installed/there */ 1098 return (ENOENT); 1099 case CAM_REQ_ABORTED: /* CCB request aborted by the host */ 1100 return (ECANCELED); 1101 case CAM_CMD_TIMEOUT: /* Command timeout */ 1102 return (ETIMEDOUT); 1103 case CAM_REQUEUE_REQ: /* Requeue to preserve transaction ordering */ 1104 return (EAGAIN); 1105 case CAM_REQ_INVALID: /* CCB request was invalid */ 1106 return (EINVAL); 1107 case CAM_RESRC_UNAVAIL: /* Resource Unavailable */ 1108 return (ENOMEM); 1109 case CAM_BUSY: /* CAM subsystem is busy */ 1110 case CAM_UA_ABORT: /* Unable to abort CCB request */ 1111 return (EBUSY); 1112 default: 1113 return (ENXIO); 1114 } 1115 } 1116 1117 static size_t 1118 targccblen(xpt_opcode func_code) 1119 { 1120 int len; 1121 1122 /* Codes we expect to see as a target */ 1123 switch (func_code) { 1124 case XPT_CONT_TARGET_IO: 1125 case XPT_SCSI_IO: 1126 len = sizeof(struct ccb_scsiio); 1127 break; 1128 case XPT_ACCEPT_TARGET_IO: 1129 len = sizeof(struct ccb_accept_tio); 1130 break; 1131 case XPT_IMMED_NOTIFY: 1132 len = sizeof(struct ccb_immed_notify); 1133 break; 1134 case XPT_REL_SIMQ: 1135 len = sizeof(struct ccb_relsim); 1136 break; 1137 case XPT_PATH_INQ: 1138 len = sizeof(struct ccb_pathinq); 1139 break; 1140 case XPT_DEBUG: 1141 len = sizeof(struct ccb_debug); 1142 break; 1143 case XPT_ABORT: 1144 len = sizeof(struct ccb_abort); 1145 break; 1146 case XPT_EN_LUN: 1147 len = sizeof(struct ccb_en_lun); 1148 break; 1149 default: 1150 len = sizeof(union ccb); 1151 break; 1152 } 1153 1154 return (len); 1155 } 1156