2 * Generic SCSI Target Kernel Mode Driver
4 * Copyright (c) 2002 Nate Lawson.
5 * Copyright (c) 1998, 1999, 2001, 2002 Justin T. Gibbs.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
38 #include <sys/malloc.h>
40 #include <sys/vnode.h>
42 #include <sys/mutex.h>
43 #include <sys/devicestat.h>
45 /* Includes to support callout */
46 #include <sys/types.h>
47 #include <sys/systm.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>
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;
66 /* Offset into the private CCB area for storing our descriptor */
67 #define targ_descr periph_priv.entries[1].ptr
69 TAILQ_HEAD(descr_queue, targ_cmd_descr);
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 */
77 /* Per-instance device software context */
79 /* CCBs (CTIOs, ATIOs, INOTs) pending on the controller */
80 struct ccb_queue pending_ccb_queue;
82 /* Command descriptors awaiting CTIO resources from the XPT */
83 struct descr_queue work_queue;
85 /* Command descriptors that have been aborted back to the user. */
86 struct descr_queue abort_queue;
89 * Queue of CCBs that have been copied out to userland, but our
90 * userland daemon has not yet seen.
92 struct ccb_queue user_ccb_queue;
94 struct cam_periph *periph;
95 struct cam_path *path;
97 struct selinfo read_select;
98 struct devstat device_stats;
99 struct callout destroy_dev_callout;
100 struct mtx destroy_mtx;
103 static d_open_t targopen;
104 static d_close_t targclose;
105 static d_read_t targread;
106 static d_write_t targwrite;
107 static d_ioctl_t targioctl;
108 static d_poll_t targpoll;
109 static d_kqfilter_t targkqfilter;
110 static void targreadfiltdetach(struct knote *kn);
111 static int targreadfilt(struct knote *kn, long hint);
112 static struct filterops targread_filtops = {
114 .f_detach = targreadfiltdetach,
115 .f_event = targreadfilt,
118 static struct cdevsw targ_cdevsw = {
119 .d_version = D_VERSION,
120 .d_flags = D_NEEDGIANT,
122 .d_close = targclose,
124 .d_write = targwrite,
125 .d_ioctl = targioctl,
128 .d_kqfilter = targkqfilter
131 static cam_status targendislun(struct cam_path *path, int enable,
132 int grp6_len, int grp7_len);
133 static cam_status targenable(struct targ_softc *softc,
134 struct cam_path *path,
135 int grp6_len, int grp7_len);
136 static cam_status targdisable(struct targ_softc *softc);
137 static periph_ctor_t targctor;
138 static periph_dtor_t targdtor;
139 static periph_start_t targstart;
140 static int targusermerge(struct targ_softc *softc,
141 struct targ_cmd_descr *descr,
143 static int targsendccb(struct targ_softc *softc, union ccb *ccb,
144 struct targ_cmd_descr *descr);
145 static void targdone(struct cam_periph *periph,
146 union ccb *done_ccb);
147 static int targreturnccb(struct targ_softc *softc,
149 static union ccb * targgetccb(struct targ_softc *softc, xpt_opcode type,
151 static void targfreeccb(struct targ_softc *softc, union ccb *ccb);
152 static struct targ_cmd_descr *
153 targgetdescr(struct targ_softc *softc);
154 static periph_init_t targinit;
155 static void targclone(void *arg, struct ucred *cred, char *name,
156 int namelen, struct cdev **dev);
157 static void targasync(void *callback_arg, u_int32_t code,
158 struct cam_path *path, void *arg);
159 static void abort_all_pending(struct targ_softc *softc);
160 static void notify_user(struct targ_softc *softc);
161 static int targcamstatus(cam_status status);
162 static size_t targccblen(xpt_opcode func_code);
163 static void targdestroy(void *);
165 static struct periph_driver targdriver =
168 TAILQ_HEAD_INITIALIZER(targdriver.units), /* generation */ 0
170 PERIPHDRIVER_DECLARE(targ, targdriver);
172 static MALLOC_DEFINE(M_TARG, "TARG", "TARG data");
175 * Create softc and initialize it. Only one proc can open each targ device.
176 * There is no locking here because a periph doesn't get created until an
177 * ioctl is issued to do so, and that can't happen until this method returns.
180 targopen(struct cdev *dev, int flags, int fmt, struct thread *td)
182 struct targ_softc *softc;
184 if (dev->si_drv1 != 0) {
188 /* Mark device busy before any potentially blocking operations */
189 dev->si_drv1 = (void *)~0;
191 /* Create the targ device, allocate its softc, initialize it */
192 if ((dev->si_flags & SI_NAMED) == 0) {
193 make_dev(&targ_cdevsw, dev2unit(dev), UID_ROOT, GID_WHEEL, 0600,
194 "targ%d", dev2unit(dev));
196 softc = malloc(sizeof(*softc), M_TARG,
198 dev->si_drv1 = softc;
199 softc->state = TARG_STATE_OPENED;
200 softc->periph = NULL;
203 TAILQ_INIT(&softc->pending_ccb_queue);
204 TAILQ_INIT(&softc->work_queue);
205 TAILQ_INIT(&softc->abort_queue);
206 TAILQ_INIT(&softc->user_ccb_queue);
207 knlist_init_mtx(&softc->read_select.si_note, NULL);
212 /* Disable LUN if enabled and teardown softc */
214 targclose(struct cdev *dev, int flag, int fmt, struct thread *td)
216 struct targ_softc *softc;
217 struct cam_periph *periph;
220 softc = (struct targ_softc *)dev->si_drv1;
221 mtx_init(&softc->destroy_mtx, "targ_destroy", "SCSI Target dev destroy", MTX_DEF);
222 callout_init_mtx(&softc->destroy_dev_callout, &softc->destroy_mtx, CALLOUT_RETURNUNLOCKED);
223 if (softc->periph == NULL) {
228 printf("%s: destroying non-enabled target\n", __func__);
229 mtx_lock(&softc->destroy_mtx);
230 callout_reset(&softc->destroy_dev_callout, hz / 2,
231 (void *)targdestroy, (void *)dev);
232 mtx_unlock(&softc->destroy_mtx);
237 * Acquire a hold on the periph so that it doesn't go away before
238 * we are ready at the end of the function.
240 periph = softc->periph;
241 cam_periph_acquire(periph);
242 cam_periph_lock(periph);
243 error = targdisable(softc);
244 if (softc->periph != NULL) {
245 cam_periph_invalidate(softc->periph);
246 softc->periph = NULL;
248 cam_periph_unlock(periph);
249 cam_periph_release(periph);
256 printf("%s: close finished error(%d)\n", __func__, error);
257 mtx_lock(&softc->destroy_mtx);
258 callout_reset(&softc->destroy_dev_callout, hz / 2,
259 (void *)targdestroy, (void *)dev);
260 mtx_unlock(&softc->destroy_mtx);
264 /* Enable/disable LUNs, set debugging level */
266 targioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
268 struct targ_softc *softc;
271 softc = (struct targ_softc *)dev->si_drv1;
276 struct ioc_enable_lun *new_lun;
277 struct cam_path *path;
280 new_lun = (struct ioc_enable_lun *)addr;
281 status = xpt_create_path_unlocked(&path, /*periph*/NULL,
285 if (status != CAM_REQ_CMP) {
286 printf("Couldn't create path, status %#x\n", status);
289 sim = xpt_path_sim(path);
291 status = targenable(softc, path, new_lun->grp6_len,
294 mtx_unlock(sim->mtx);
298 if (softc->periph == NULL) {
299 status = CAM_DEV_NOT_THERE;
302 cam_periph_lock(softc->periph);
303 status = targdisable(softc);
304 cam_periph_unlock(softc->periph);
309 struct ccb_debug cdbg;
311 /* If no periph available, disallow debugging changes */
312 if ((softc->state & TARG_STATE_LUN_ENABLED) == 0) {
313 status = CAM_DEV_NOT_THERE;
316 bzero(&cdbg, sizeof cdbg);
317 if (*((int *)addr) != 0)
318 cdbg.flags = CAM_DEBUG_PERIPH;
320 cdbg.flags = CAM_DEBUG_NONE;
321 cam_periph_lock(softc->periph);
322 xpt_setup_ccb(&cdbg.ccb_h, softc->path, CAM_PRIORITY_NORMAL);
323 cdbg.ccb_h.func_code = XPT_DEBUG;
324 cdbg.ccb_h.cbfcnp = targdone;
326 xpt_action((union ccb *)&cdbg);
327 cam_periph_unlock(softc->periph);
328 status = cdbg.ccb_h.status & CAM_STATUS_MASK;
330 status = CAM_FUNC_NOTAVAIL;
335 status = CAM_PROVIDE_FAIL;
339 return (targcamstatus(status));
342 /* Writes are always ready, reads wait for user_ccb_queue or abort_queue */
344 targpoll(struct cdev *dev, int poll_events, struct thread *td)
346 struct targ_softc *softc;
349 softc = (struct targ_softc *)dev->si_drv1;
351 /* Poll for write() is always ok. */
352 revents = poll_events & (POLLOUT | POLLWRNORM);
353 if ((poll_events & (POLLIN | POLLRDNORM)) != 0) {
354 /* Poll for read() depends on user and abort queues. */
355 cam_periph_lock(softc->periph);
356 if (!TAILQ_EMPTY(&softc->user_ccb_queue) ||
357 !TAILQ_EMPTY(&softc->abort_queue)) {
358 revents |= poll_events & (POLLIN | POLLRDNORM);
360 cam_periph_unlock(softc->periph);
361 /* Only sleep if the user didn't poll for write. */
363 selrecord(td, &softc->read_select);
370 targkqfilter(struct cdev *dev, struct knote *kn)
372 struct targ_softc *softc;
374 softc = (struct targ_softc *)dev->si_drv1;
375 kn->kn_hook = (caddr_t)softc;
376 kn->kn_fop = &targread_filtops;
377 knlist_add(&softc->read_select.si_note, kn, 0);
382 targreadfiltdetach(struct knote *kn)
384 struct targ_softc *softc;
386 softc = (struct targ_softc *)kn->kn_hook;
387 knlist_remove(&softc->read_select.si_note, kn, 0);
390 /* Notify the user's kqueue when the user queue or abort queue gets a CCB */
392 targreadfilt(struct knote *kn, long hint)
394 struct targ_softc *softc;
397 softc = (struct targ_softc *)kn->kn_hook;
398 cam_periph_lock(softc->periph);
399 retval = !TAILQ_EMPTY(&softc->user_ccb_queue) ||
400 !TAILQ_EMPTY(&softc->abort_queue);
401 cam_periph_unlock(softc->periph);
405 /* Send the HBA the enable/disable message */
407 targendislun(struct cam_path *path, int enable, int grp6_len, int grp7_len)
409 struct ccb_en_lun en_ccb;
412 /* Tell the lun to begin answering selects */
413 xpt_setup_ccb(&en_ccb.ccb_h, path, CAM_PRIORITY_NORMAL);
414 en_ccb.ccb_h.func_code = XPT_EN_LUN;
415 /* Don't need support for any vendor specific commands */
416 en_ccb.grp6_len = grp6_len;
417 en_ccb.grp7_len = grp7_len;
418 en_ccb.enable = enable ? 1 : 0;
419 xpt_action((union ccb *)&en_ccb);
420 status = en_ccb.ccb_h.status & CAM_STATUS_MASK;
421 if (status != CAM_REQ_CMP) {
422 xpt_print(path, "%sable lun CCB rejected, status %#x\n",
423 enable ? "en" : "dis", status);
428 /* Enable target mode on a LUN, given its path */
430 targenable(struct targ_softc *softc, struct cam_path *path, int grp6_len,
433 struct cam_periph *periph;
434 struct ccb_pathinq cpi;
437 if ((softc->state & TARG_STATE_LUN_ENABLED) != 0)
438 return (CAM_LUN_ALRDY_ENA);
440 /* Make sure SIM supports target mode */
441 xpt_setup_ccb(&cpi.ccb_h, path, CAM_PRIORITY_NORMAL);
442 cpi.ccb_h.func_code = XPT_PATH_INQ;
443 xpt_action((union ccb *)&cpi);
444 status = cpi.ccb_h.status & CAM_STATUS_MASK;
445 if (status != CAM_REQ_CMP) {
446 printf("pathinq failed, status %#x\n", status);
449 if ((cpi.target_sprt & PIT_PROCESSOR) == 0) {
450 printf("controller does not support target mode\n");
451 status = CAM_FUNC_NOTAVAIL;
455 /* Destroy any periph on our path if it is disabled */
456 periph = cam_periph_find(path, "targ");
457 if (periph != NULL) {
458 struct targ_softc *del_softc;
460 del_softc = (struct targ_softc *)periph->softc;
461 if ((del_softc->state & TARG_STATE_LUN_ENABLED) == 0) {
462 cam_periph_invalidate(del_softc->periph);
463 del_softc->periph = NULL;
465 printf("Requested path still in use by targ%d\n",
466 periph->unit_number);
467 status = CAM_LUN_ALRDY_ENA;
472 /* Create a periph instance attached to this path */
473 status = cam_periph_alloc(targctor, NULL, targdtor, targstart,
474 "targ", CAM_PERIPH_BIO, path, targasync, 0, softc);
475 if (status != CAM_REQ_CMP) {
476 printf("cam_periph_alloc failed, status %#x\n", status);
480 /* Ensure that the periph now exists. */
481 if (cam_periph_find(path, "targ") == NULL) {
482 panic("targenable: succeeded but no periph?");
486 /* Send the enable lun message */
487 status = targendislun(path, /*enable*/1, grp6_len, grp7_len);
488 if (status != CAM_REQ_CMP) {
489 printf("enable lun failed, status %#x\n", status);
492 softc->state |= TARG_STATE_LUN_ENABLED;
498 /* Disable this softc's target instance if enabled */
500 targdisable(struct targ_softc *softc)
504 if ((softc->state & TARG_STATE_LUN_ENABLED) == 0)
505 return (CAM_REQ_CMP);
507 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targdisable\n"));
509 /* Abort any ccbs pending on the controller */
510 abort_all_pending(softc);
512 /* Disable this lun */
513 status = targendislun(softc->path, /*enable*/0,
514 /*grp6_len*/0, /*grp7_len*/0);
515 if (status == CAM_REQ_CMP)
516 softc->state &= ~TARG_STATE_LUN_ENABLED;
518 printf("Disable lun failed, status %#x\n", status);
523 /* Initialize a periph (called from cam_periph_alloc) */
525 targctor(struct cam_periph *periph, void *arg)
527 struct targ_softc *softc;
529 /* Store pointer to softc for periph-driven routines */
530 softc = (struct targ_softc *)arg;
531 periph->softc = softc;
532 softc->periph = periph;
533 softc->path = periph->path;
534 return (CAM_REQ_CMP);
538 targdtor(struct cam_periph *periph)
540 struct targ_softc *softc;
541 struct ccb_hdr *ccb_h;
542 struct targ_cmd_descr *descr;
544 softc = (struct targ_softc *)periph->softc;
547 * targdisable() aborts CCBs back to the user and leaves them
548 * on user_ccb_queue and abort_queue in case the user is still
549 * interested in them. We free them now.
551 while ((ccb_h = TAILQ_FIRST(&softc->user_ccb_queue)) != NULL) {
552 TAILQ_REMOVE(&softc->user_ccb_queue, ccb_h, periph_links.tqe);
553 targfreeccb(softc, (union ccb *)ccb_h);
555 while ((descr = TAILQ_FIRST(&softc->abort_queue)) != NULL) {
556 TAILQ_REMOVE(&softc->abort_queue, descr, tqe);
560 softc->periph = NULL;
562 periph->softc = NULL;
565 /* Receive CCBs from user mode proc and send them to the HBA */
567 targwrite(struct cdev *dev, struct uio *uio, int ioflag)
570 struct targ_softc *softc;
571 struct targ_cmd_descr *descr;
572 int write_len, error;
573 int func_code, priority;
575 softc = (struct targ_softc *)dev->si_drv1;
576 write_len = error = 0;
577 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
578 ("write - uio_resid %zd\n", uio->uio_resid));
579 while (uio->uio_resid >= sizeof(user_ccb) && error == 0) {
582 error = uiomove((caddr_t)&user_ccb, sizeof(user_ccb), uio);
584 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
585 ("write - uiomove failed (%d)\n", error));
588 priority = fuword32(&user_ccb->ccb_h.pinfo.priority);
589 if (priority == CAM_PRIORITY_NONE) {
593 func_code = fuword32(&user_ccb->ccb_h.func_code);
595 case XPT_ACCEPT_TARGET_IO:
596 case XPT_IMMED_NOTIFY:
597 cam_periph_lock(softc->periph);
598 ccb = targgetccb(softc, func_code, priority);
599 descr = (struct targ_cmd_descr *)ccb->ccb_h.targ_descr;
600 descr->user_ccb = user_ccb;
601 descr->func_code = func_code;
602 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
603 ("Sent ATIO/INOT (%p)\n", user_ccb));
605 TAILQ_INSERT_TAIL(&softc->pending_ccb_queue,
608 cam_periph_unlock(softc->periph);
611 cam_periph_lock(softc->periph);
612 if ((func_code & XPT_FC_QUEUED) != 0) {
613 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
614 ("Sending queued ccb %#x (%p)\n",
615 func_code, user_ccb));
616 descr = targgetdescr(softc);
617 descr->user_ccb = user_ccb;
618 descr->priority = priority;
619 descr->func_code = func_code;
620 TAILQ_INSERT_TAIL(&softc->work_queue,
622 xpt_schedule(softc->periph, priority);
624 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
625 ("Sending inline ccb %#x (%p)\n",
626 func_code, user_ccb));
627 ccb = targgetccb(softc, func_code, priority);
628 descr = (struct targ_cmd_descr *)
629 ccb->ccb_h.targ_descr;
630 descr->user_ccb = user_ccb;
631 descr->priority = priority;
632 descr->func_code = func_code;
633 if (targusermerge(softc, descr, ccb) != EFAULT)
634 targsendccb(softc, ccb, descr);
635 targreturnccb(softc, ccb);
637 cam_periph_unlock(softc->periph);
640 write_len += sizeof(user_ccb);
644 * If we've successfully taken in some amount of
645 * data, return success for that data first. If
646 * an error is persistent, it will be reported
649 if (error != 0 && write_len == 0)
651 if (write_len == 0 && uio->uio_resid != 0)
656 /* Process requests (descrs) via the periph-supplied CCBs */
658 targstart(struct cam_periph *periph, union ccb *start_ccb)
660 struct targ_softc *softc;
661 struct targ_cmd_descr *descr, *next_descr;
664 softc = (struct targ_softc *)periph->softc;
665 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targstart %p\n", start_ccb));
667 descr = TAILQ_FIRST(&softc->work_queue);
669 xpt_release_ccb(start_ccb);
671 TAILQ_REMOVE(&softc->work_queue, descr, tqe);
672 next_descr = TAILQ_FIRST(&softc->work_queue);
674 /* Initiate a transaction using the descr and supplied CCB */
675 error = targusermerge(softc, descr, start_ccb);
677 error = targsendccb(softc, start_ccb, descr);
679 xpt_print(periph->path,
680 "targsendccb failed, err %d\n", error);
681 xpt_release_ccb(start_ccb);
682 suword(&descr->user_ccb->ccb_h.status,
684 TAILQ_INSERT_TAIL(&softc->abort_queue, descr, tqe);
688 /* If we have more work to do, stay scheduled */
689 if (next_descr != NULL)
690 xpt_schedule(periph, next_descr->priority);
695 targusermerge(struct targ_softc *softc, struct targ_cmd_descr *descr,
698 struct ccb_hdr *u_ccbh, *k_ccbh;
702 u_ccbh = &descr->user_ccb->ccb_h;
703 k_ccbh = &ccb->ccb_h;
706 * There are some fields in the CCB header that need to be
707 * preserved, the rest we get from the user ccb. (See xpt_merge_ccb)
709 xpt_setup_ccb(k_ccbh, softc->path, descr->priority);
710 k_ccbh->retry_count = fuword32(&u_ccbh->retry_count);
711 k_ccbh->func_code = descr->func_code;
712 k_ccbh->flags = fuword32(&u_ccbh->flags);
713 k_ccbh->timeout = fuword32(&u_ccbh->timeout);
714 ccb_len = targccblen(k_ccbh->func_code) - sizeof(struct ccb_hdr);
715 error = copyin(u_ccbh + 1, k_ccbh + 1, ccb_len);
717 k_ccbh->status = CAM_REQ_CMP_ERR;
721 /* Translate usermode abort_ccb pointer to its kernel counterpart */
722 if (k_ccbh->func_code == XPT_ABORT) {
723 struct ccb_abort *cab;
724 struct ccb_hdr *ccb_h;
726 cab = (struct ccb_abort *)ccb;
727 TAILQ_FOREACH(ccb_h, &softc->pending_ccb_queue,
729 struct targ_cmd_descr *ab_descr;
731 ab_descr = (struct targ_cmd_descr *)ccb_h->targ_descr;
732 if (ab_descr->user_ccb == cab->abort_ccb) {
733 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
734 ("Changing abort for %p to %p\n",
735 cab->abort_ccb, ccb_h));
736 cab->abort_ccb = (union ccb *)ccb_h;
740 /* CCB not found, set appropriate status */
742 k_ccbh->status = CAM_PATH_INVALID;
750 /* Build and send a kernel CCB formed from descr->user_ccb */
752 targsendccb(struct targ_softc *softc, union ccb *ccb,
753 struct targ_cmd_descr *descr)
755 struct cam_periph_map_info *mapinfo;
756 struct ccb_hdr *ccb_h;
760 mapinfo = &descr->mapinfo;
761 mapinfo->num_bufs_used = 0;
764 * There's no way for the user to have a completion
765 * function, so we put our own completion function in here.
766 * We also stash in a reference to our descriptor so targreturnccb()
767 * can find our mapping info.
769 ccb_h->cbfcnp = targdone;
770 ccb_h->targ_descr = descr;
773 * We only attempt to map the user memory into kernel space
774 * if they haven't passed in a physical memory pointer,
775 * and if there is actually an I/O operation to perform.
776 * Right now cam_periph_mapmem() only supports SCSI and device
777 * match CCBs. For the SCSI CCBs, we only pass the CCB in if
778 * there's actually data to map. cam_periph_mapmem() will do the
779 * right thing, even if there isn't data to map, but since CCBs
780 * without data are a reasonably common occurance (e.g. test unit
781 * ready), it will save a few cycles if we check for it here.
783 if (((ccb_h->flags & CAM_DATA_PHYS) == 0)
784 && (((ccb_h->func_code == XPT_CONT_TARGET_IO)
785 && ((ccb_h->flags & CAM_DIR_MASK) != CAM_DIR_NONE))
786 || (ccb_h->func_code == XPT_DEV_MATCH))) {
788 error = cam_periph_mapmem(ccb, mapinfo);
791 * cam_periph_mapmem returned an error, we can't continue.
792 * Return the error to the user.
795 ccb_h->status = CAM_REQ_CMP_ERR;
796 mapinfo->num_bufs_used = 0;
802 * Once queued on the pending CCB list, this CCB will be protected
803 * by our error recovery handler.
805 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("sendccb %p\n", ccb));
806 if (XPT_FC_IS_QUEUED(ccb)) {
807 TAILQ_INSERT_TAIL(&softc->pending_ccb_queue, ccb_h,
815 /* Completion routine for CCBs (called at splsoftcam) */
817 targdone(struct cam_periph *periph, union ccb *done_ccb)
819 struct targ_softc *softc;
822 CAM_DEBUG(periph->path, CAM_DEBUG_PERIPH, ("targdone %p\n", done_ccb));
823 softc = (struct targ_softc *)periph->softc;
824 TAILQ_REMOVE(&softc->pending_ccb_queue, &done_ccb->ccb_h,
826 status = done_ccb->ccb_h.status & CAM_STATUS_MASK;
828 /* If we're no longer enabled, throw away CCB */
829 if ((softc->state & TARG_STATE_LUN_ENABLED) == 0) {
830 targfreeccb(softc, done_ccb);
833 /* abort_all_pending() waits for pending queue to be empty */
834 if (TAILQ_EMPTY(&softc->pending_ccb_queue))
835 wakeup(&softc->pending_ccb_queue);
837 switch (done_ccb->ccb_h.func_code) {
838 /* All FC_*_QUEUED CCBs go back to userland */
839 case XPT_IMMED_NOTIFY:
840 case XPT_ACCEPT_TARGET_IO:
841 case XPT_CONT_TARGET_IO:
842 TAILQ_INSERT_TAIL(&softc->user_ccb_queue, &done_ccb->ccb_h,
844 cam_periph_unlock(softc->periph);
846 cam_periph_lock(softc->periph);
849 panic("targdone: impossible xpt opcode %#x",
850 done_ccb->ccb_h.func_code);
855 /* Return CCBs to the user from the user queue and abort queue */
857 targread(struct cdev *dev, struct uio *uio, int ioflag)
859 struct descr_queue *abort_queue;
860 struct targ_cmd_descr *user_descr;
861 struct targ_softc *softc;
862 struct ccb_queue *user_queue;
863 struct ccb_hdr *ccb_h;
869 softc = (struct targ_softc *)dev->si_drv1;
870 user_queue = &softc->user_ccb_queue;
871 abort_queue = &softc->abort_queue;
872 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targread\n"));
874 /* If no data is available, wait or return immediately */
875 cam_periph_lock(softc->periph);
876 ccb_h = TAILQ_FIRST(user_queue);
877 user_descr = TAILQ_FIRST(abort_queue);
878 while (ccb_h == NULL && user_descr == NULL) {
879 if ((ioflag & IO_NDELAY) == 0) {
880 error = msleep(user_queue, softc->periph->sim->mtx,
881 PRIBIO | PCATCH, "targrd", 0);
882 ccb_h = TAILQ_FIRST(user_queue);
883 user_descr = TAILQ_FIRST(abort_queue);
885 if (error == ERESTART) {
892 cam_periph_unlock(softc->periph);
897 /* Data is available so fill the user's buffer */
898 while (ccb_h != NULL) {
899 struct targ_cmd_descr *descr;
901 if (uio->uio_resid < sizeof(user_ccb))
903 TAILQ_REMOVE(user_queue, ccb_h, periph_links.tqe);
904 descr = (struct targ_cmd_descr *)ccb_h->targ_descr;
905 user_ccb = descr->user_ccb;
906 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
907 ("targread ccb %p (%p)\n", ccb_h, user_ccb));
908 error = targreturnccb(softc, (union ccb *)ccb_h);
911 cam_periph_unlock(softc->periph);
912 error = uiomove((caddr_t)&user_ccb, sizeof(user_ccb), uio);
913 cam_periph_lock(softc->periph);
916 read_len += sizeof(user_ccb);
918 ccb_h = TAILQ_FIRST(user_queue);
921 /* Flush out any aborted descriptors */
922 while (user_descr != NULL) {
923 if (uio->uio_resid < sizeof(user_ccb))
925 TAILQ_REMOVE(abort_queue, user_descr, tqe);
926 user_ccb = user_descr->user_ccb;
927 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
928 ("targread aborted descr %p (%p)\n",
929 user_descr, user_ccb));
930 suword(&user_ccb->ccb_h.status, CAM_REQ_ABORTED);
931 cam_periph_unlock(softc->periph);
932 error = uiomove((caddr_t)&user_ccb, sizeof(user_ccb), uio);
933 cam_periph_lock(softc->periph);
936 read_len += sizeof(user_ccb);
938 user_descr = TAILQ_FIRST(abort_queue);
942 * If we've successfully read some amount of data, don't report an
943 * error. If the error is persistent, it will be reported on the
946 if (read_len == 0 && uio->uio_resid != 0)
950 cam_periph_unlock(softc->periph);
954 /* Copy completed ccb back to the user */
956 targreturnccb(struct targ_softc *softc, union ccb *ccb)
958 struct targ_cmd_descr *descr;
959 struct ccb_hdr *u_ccbh;
963 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("targreturnccb %p\n", ccb));
964 descr = (struct targ_cmd_descr *)ccb->ccb_h.targ_descr;
965 u_ccbh = &descr->user_ccb->ccb_h;
967 /* Copy out the central portion of the ccb_hdr */
968 copyout(&ccb->ccb_h.retry_count, &u_ccbh->retry_count,
969 offsetof(struct ccb_hdr, periph_priv) -
970 offsetof(struct ccb_hdr, retry_count));
972 /* Copy out the rest of the ccb (after the ccb_hdr) */
973 ccb_len = targccblen(ccb->ccb_h.func_code) - sizeof(struct ccb_hdr);
974 if (descr->mapinfo.num_bufs_used != 0)
975 cam_periph_unmapmem(ccb, &descr->mapinfo);
976 error = copyout(&ccb->ccb_h + 1, u_ccbh + 1, ccb_len);
978 xpt_print(softc->path,
979 "targreturnccb - CCB copyout failed (%d)\n", error);
981 /* Free CCB or send back to devq. */
982 targfreeccb(softc, ccb);
988 targgetccb(struct targ_softc *softc, xpt_opcode type, int priority)
993 ccb_len = targccblen(type);
994 ccb = malloc(ccb_len, M_TARG, M_NOWAIT);
995 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("getccb %p\n", ccb));
999 xpt_setup_ccb(&ccb->ccb_h, softc->path, priority);
1000 ccb->ccb_h.func_code = type;
1001 ccb->ccb_h.cbfcnp = targdone;
1002 ccb->ccb_h.targ_descr = targgetdescr(softc);
1003 if (ccb->ccb_h.targ_descr == NULL) {
1011 targfreeccb(struct targ_softc *softc, union ccb *ccb)
1013 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH, ("targfreeccb descr %p and\n",
1014 ccb->ccb_h.targ_descr));
1015 free(ccb->ccb_h.targ_descr, M_TARG);
1017 switch (ccb->ccb_h.func_code) {
1018 case XPT_ACCEPT_TARGET_IO:
1019 case XPT_IMMED_NOTIFY:
1020 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH, ("freeing ccb %p\n", ccb));
1024 /* Send back CCB if we got it from the periph */
1025 if (XPT_FC_IS_QUEUED(ccb)) {
1026 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH,
1027 ("returning queued ccb %p\n", ccb));
1028 xpt_release_ccb(ccb);
1030 CAM_DEBUG_PRINT(CAM_DEBUG_PERIPH,
1031 ("freeing ccb %p\n", ccb));
1038 static struct targ_cmd_descr *
1039 targgetdescr(struct targ_softc *softc)
1041 struct targ_cmd_descr *descr;
1043 descr = malloc(sizeof(*descr), M_TARG,
1046 descr->mapinfo.num_bufs_used = 0;
1054 EVENTHANDLER_REGISTER(dev_clone, targclone, 0, 1000);
1058 targclone(void *arg, struct ucred *cred, char *name, int namelen,
1065 if (dev_stdclone(name, NULL, "targ", &u) != 1)
1067 *dev = make_dev(&targ_cdevsw, u, UID_ROOT, GID_WHEEL,
1070 (*dev)->si_flags |= SI_CHEAPCLONE;
1074 targasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
1076 /* All events are handled in usermode by INOTs */
1077 panic("targasync() called, should be an INOT instead");
1080 /* Cancel all pending requests and CCBs awaiting work. */
1082 abort_all_pending(struct targ_softc *softc)
1084 struct targ_cmd_descr *descr;
1085 struct ccb_abort cab;
1086 struct ccb_hdr *ccb_h;
1087 struct cam_sim *sim;
1089 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH, ("abort_all_pending\n"));
1091 /* First abort the descriptors awaiting resources */
1092 while ((descr = TAILQ_FIRST(&softc->work_queue)) != NULL) {
1093 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
1094 ("Aborting descr from workq %p\n", descr));
1095 TAILQ_REMOVE(&softc->work_queue, descr, tqe);
1096 TAILQ_INSERT_TAIL(&softc->abort_queue, descr, tqe);
1100 * Then abort all pending CCBs.
1101 * targdone() will return the aborted CCB via user_ccb_queue
1103 xpt_setup_ccb(&cab.ccb_h, softc->path, CAM_PRIORITY_NORMAL);
1104 cab.ccb_h.func_code = XPT_ABORT;
1105 cab.ccb_h.status = CAM_REQ_CMP_ERR;
1106 TAILQ_FOREACH(ccb_h, &softc->pending_ccb_queue, periph_links.tqe) {
1107 CAM_DEBUG(softc->path, CAM_DEBUG_PERIPH,
1108 ("Aborting pending CCB %p\n", ccb_h));
1109 cab.abort_ccb = (union ccb *)ccb_h;
1110 xpt_action((union ccb *)&cab);
1111 if (cab.ccb_h.status != CAM_REQ_CMP) {
1112 xpt_print(cab.ccb_h.path,
1113 "Unable to abort CCB, status %#x\n",
1118 /* If we aborted at least one pending CCB ok, wait for it. */
1119 if (cab.ccb_h.status == CAM_REQ_CMP) {
1120 sim = xpt_path_sim(softc->path);
1121 msleep(&softc->pending_ccb_queue, sim->mtx,
1122 PRIBIO | PCATCH, "tgabrt", 0);
1125 /* If we aborted anything from the work queue, wakeup user. */
1126 if (!TAILQ_EMPTY(&softc->user_ccb_queue)
1127 || !TAILQ_EMPTY(&softc->abort_queue)) {
1128 cam_periph_unlock(softc->periph);
1130 cam_periph_lock(softc->periph);
1134 /* Notify the user that data is ready */
1136 notify_user(struct targ_softc *softc)
1139 * Notify users sleeping via poll(), kqueue(), and
1142 selwakeuppri(&softc->read_select, PRIBIO);
1143 KNOTE_UNLOCKED(&softc->read_select.si_note, 0);
1144 wakeup(&softc->user_ccb_queue);
1147 /* Convert CAM status to errno values */
1149 targcamstatus(cam_status status)
1151 switch (status & CAM_STATUS_MASK) {
1152 case CAM_REQ_CMP: /* CCB request completed without error */
1154 case CAM_REQ_INPROG: /* CCB request is in progress */
1155 return (EINPROGRESS);
1156 case CAM_REQ_CMP_ERR: /* CCB request completed with an error */
1158 case CAM_PROVIDE_FAIL: /* Unable to provide requested capability */
1160 case CAM_FUNC_NOTAVAIL: /* The requested function is not available */
1162 case CAM_LUN_ALRDY_ENA: /* LUN is already enabled for target mode */
1163 return (EADDRINUSE);
1164 case CAM_PATH_INVALID: /* Supplied Path ID is invalid */
1165 case CAM_DEV_NOT_THERE: /* SCSI Device Not Installed/there */
1167 case CAM_REQ_ABORTED: /* CCB request aborted by the host */
1169 case CAM_CMD_TIMEOUT: /* Command timeout */
1171 case CAM_REQUEUE_REQ: /* Requeue to preserve transaction ordering */
1173 case CAM_REQ_INVALID: /* CCB request was invalid */
1175 case CAM_RESRC_UNAVAIL: /* Resource Unavailable */
1177 case CAM_BUSY: /* CAM subsystem is busy */
1178 case CAM_UA_ABORT: /* Unable to abort CCB request */
1186 targccblen(xpt_opcode func_code)
1190 /* Codes we expect to see as a target */
1191 switch (func_code) {
1192 case XPT_CONT_TARGET_IO:
1194 len = sizeof(struct ccb_scsiio);
1196 case XPT_ACCEPT_TARGET_IO:
1197 len = sizeof(struct ccb_accept_tio);
1199 case XPT_IMMED_NOTIFY:
1200 len = sizeof(struct ccb_immed_notify);
1203 len = sizeof(struct ccb_relsim);
1206 len = sizeof(struct ccb_pathinq);
1209 len = sizeof(struct ccb_debug);
1212 len = sizeof(struct ccb_abort);
1215 len = sizeof(struct ccb_en_lun);
1218 len = sizeof(union ccb);
1226 * work around to destroy targ device
1227 * outside of targclose
1230 targdestroy(void *dev)
1232 struct cdev *device = (struct cdev *)dev;
1233 struct targ_softc *softc = (struct targ_softc *)device->si_drv1;
1236 callout_stop(&softc->destroy_dev_callout);
1239 mtx_unlock(&softc->destroy_mtx);
1240 mtx_destroy(&softc->destroy_mtx);
1241 free(softc, M_TARG);
1242 device->si_drv1 = 0;
1243 destroy_dev(device);
1244 printf("%s: destroyed dev\n", __func__);