2 * Implementation of the Target Mode 'Black Hole device' for CAM.
4 * Copyright (c) 1999 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/queue.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/types.h>
39 #include <sys/devicestat.h>
40 #include <sys/malloc.h>
44 #include <cam/cam_ccb.h>
45 #include <cam/cam_periph.h>
46 #include <cam/cam_queue.h>
47 #include <cam/cam_xpt_periph.h>
48 #include <cam/cam_debug.h>
50 #include <cam/scsi/scsi_all.h>
51 #include <cam/scsi/scsi_message.h>
53 MALLOC_DEFINE(M_SCSIBH, "SCSI bh", "SCSI blackhole buffers");
57 TARGBH_STATE_EXCEPTION,
62 TARGBH_FLAG_NONE = 0x00,
63 TARGBH_FLAG_LUN_ENABLED = 0x01
72 #define MAX_IMMEDIATE 16
73 #define MAX_BUF_SIZE 256 /* Max inquiry/sense/mode page transfer */
75 /* Offsets into our private CCB area for storing accept information */
76 #define ccb_type ppriv_field0
77 #define ccb_descr ppriv_ptr1
79 /* We stick a pointer to the originating accept TIO in each continue I/O CCB */
80 #define ccb_atio ppriv_ptr1
82 TAILQ_HEAD(ccb_queue, ccb_hdr);
85 struct ccb_queue pending_queue;
86 struct ccb_queue work_queue;
87 struct ccb_queue unknown_atio_queue;
88 struct devstat device_stats;
93 struct ccb_accept_tio *accept_tio_list;
94 struct ccb_hdr_slist immed_notify_slist;
97 struct targbh_cmd_desc {
98 struct ccb_accept_tio* atio_link;
99 u_int data_resid; /* How much left to transfer */
100 u_int data_increment;/* Amount to send before next disconnect */
101 void* data; /* The data. Can be from backing_store or not */
102 void* backing_store;/* Backing store allocated for this descriptor*/
103 u_int max_size; /* Size of backing_store */
105 u_int8_t status; /* Status to return to initiator */
108 static struct scsi_inquiry_data no_lun_inq_data =
110 T_NODEVICE | (SID_QUAL_BAD_LU << 5), 0,
111 /* version */2, /* format version */2
114 static struct scsi_sense_data no_lun_sense_data =
116 SSD_CURRENT_ERROR|SSD_ERRCODE_VALID,
120 /*extra_len*/offsetof(struct scsi_sense_data, fru)
121 - offsetof(struct scsi_sense_data, extra_len),
123 /* Logical Unit Not Supported */
124 /*ASC*/0x25, /*ASCQ*/0
127 static const int request_sense_size = offsetof(struct scsi_sense_data, fru);
129 static periph_init_t targbhinit;
130 static void targbhasync(void *callback_arg, u_int32_t code,
131 struct cam_path *path, void *arg);
132 static cam_status targbhenlun(struct cam_periph *periph);
133 static cam_status targbhdislun(struct cam_periph *periph);
134 static periph_ctor_t targbhctor;
135 static periph_dtor_t targbhdtor;
136 static periph_start_t targbhstart;
137 static void targbhdone(struct cam_periph *periph,
138 union ccb *done_ccb);
140 static int targbherror(union ccb *ccb, u_int32_t cam_flags,
141 u_int32_t sense_flags);
143 static struct targbh_cmd_desc* targbhallocdescr(void);
144 static void targbhfreedescr(struct targbh_cmd_desc *buf);
146 static struct periph_driver targbhdriver =
148 targbhinit, "targbh",
149 TAILQ_HEAD_INITIALIZER(targbhdriver.units), /* generation */ 0
152 PERIPHDRIVER_DECLARE(targbh, targbhdriver);
158 struct cam_path *path;
161 * Install a global async callback. This callback will
162 * receive async callbacks like "new path registered".
164 status = xpt_create_path(&path, /*periph*/NULL, CAM_XPT_PATH_ID,
165 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
167 if (status == CAM_REQ_CMP) {
168 struct ccb_setasync csa;
170 xpt_setup_ccb(&csa.ccb_h, path, /*priority*/5);
171 csa.ccb_h.func_code = XPT_SASYNC_CB;
172 csa.event_enable = AC_PATH_REGISTERED | AC_PATH_DEREGISTERED;
173 csa.callback = targbhasync;
174 csa.callback_arg = NULL;
175 xpt_action((union ccb *)&csa);
176 status = csa.ccb_h.status;
180 if (status != CAM_REQ_CMP) {
181 printf("targbh: Failed to attach master async callback "
182 "due to status 0x%x!\n", status);
187 targbhasync(void *callback_arg, u_int32_t code,
188 struct cam_path *path, void *arg)
190 struct cam_path *new_path;
191 struct ccb_pathinq *cpi;
192 path_id_t bus_path_id;
195 cpi = (struct ccb_pathinq *)arg;
196 if (code == AC_PATH_REGISTERED)
197 bus_path_id = cpi->ccb_h.path_id;
199 bus_path_id = xpt_path_path_id(path);
201 * Allocate a peripheral instance for
202 * this target instance.
204 status = xpt_create_path(&new_path, NULL,
206 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
207 if (status != CAM_REQ_CMP) {
208 printf("targbhasync: Unable to create path "
209 "due to status 0x%x\n", status);
214 case AC_PATH_REGISTERED:
216 /* Only attach to controllers that support target mode */
217 if ((cpi->target_sprt & PIT_PROCESSOR) == 0)
220 status = cam_periph_alloc(targbhctor, NULL, targbhdtor,
222 "targbh", CAM_PERIPH_BIO,
223 new_path, targbhasync,
228 case AC_PATH_DEREGISTERED:
230 struct cam_periph *periph;
232 if ((periph = cam_periph_find(new_path, "targbh")) != NULL)
233 cam_periph_invalidate(periph);
239 xpt_free_path(new_path);
242 /* Attempt to enable our lun */
244 targbhenlun(struct cam_periph *periph)
247 struct targbh_softc *softc;
251 softc = (struct targbh_softc *)periph->softc;
253 if ((softc->flags & TARGBH_FLAG_LUN_ENABLED) != 0)
254 return (CAM_REQ_CMP);
256 xpt_setup_ccb(&immed_ccb.ccb_h, periph->path, /*priority*/1);
257 immed_ccb.ccb_h.func_code = XPT_EN_LUN;
259 /* Don't need support for any vendor specific commands */
260 immed_ccb.cel.grp6_len = 0;
261 immed_ccb.cel.grp7_len = 0;
262 immed_ccb.cel.enable = 1;
263 xpt_action(&immed_ccb);
264 status = immed_ccb.ccb_h.status;
265 if (status != CAM_REQ_CMP) {
266 xpt_print(periph->path,
267 "targbhenlun - Enable Lun Rejected with status 0x%x\n",
272 softc->flags |= TARGBH_FLAG_LUN_ENABLED;
275 * Build up a buffer of accept target I/O
276 * operations for incoming selections.
278 for (i = 0; i < MAX_ACCEPT; i++) {
279 struct ccb_accept_tio *atio;
281 atio = (struct ccb_accept_tio*)malloc(sizeof(*atio), M_SCSIBH,
284 status = CAM_RESRC_UNAVAIL;
288 atio->ccb_h.ccb_descr = targbhallocdescr();
290 if (atio->ccb_h.ccb_descr == NULL) {
291 free(atio, M_SCSIBH);
292 status = CAM_RESRC_UNAVAIL;
296 xpt_setup_ccb(&atio->ccb_h, periph->path, /*priority*/1);
297 atio->ccb_h.func_code = XPT_ACCEPT_TARGET_IO;
298 atio->ccb_h.cbfcnp = targbhdone;
299 xpt_action((union ccb *)atio);
300 status = atio->ccb_h.status;
301 if (status != CAM_REQ_INPROG) {
302 targbhfreedescr(atio->ccb_h.ccb_descr);
303 free(atio, M_SCSIBH);
306 ((struct targbh_cmd_desc*)atio->ccb_h.ccb_descr)->atio_link =
307 softc->accept_tio_list;
308 softc->accept_tio_list = atio;
312 xpt_print(periph->path,
313 "targbhenlun - Could not allocate accept tio CCBs: status "
315 targbhdislun(periph);
316 return (CAM_REQ_CMP_ERR);
320 * Build up a buffer of immediate notify CCBs
321 * so the SIM can tell us of asynchronous target mode events.
323 for (i = 0; i < MAX_ACCEPT; i++) {
324 struct ccb_immed_notify *inot;
326 inot = (struct ccb_immed_notify*)malloc(sizeof(*inot), M_SCSIBH,
330 status = CAM_RESRC_UNAVAIL;
334 xpt_setup_ccb(&inot->ccb_h, periph->path, /*priority*/1);
335 inot->ccb_h.func_code = XPT_IMMED_NOTIFY;
336 inot->ccb_h.cbfcnp = targbhdone;
337 xpt_action((union ccb *)inot);
338 status = inot->ccb_h.status;
339 if (status != CAM_REQ_INPROG) {
340 free(inot, M_SCSIBH);
343 SLIST_INSERT_HEAD(&softc->immed_notify_slist, &inot->ccb_h,
348 xpt_print(periph->path,
349 "targbhenlun - Could not allocate immediate notify "
350 "CCBs: status = 0x%x\n", status);
351 targbhdislun(periph);
352 return (CAM_REQ_CMP_ERR);
355 return (CAM_REQ_CMP);
359 targbhdislun(struct cam_periph *periph)
362 struct targbh_softc *softc;
363 struct ccb_accept_tio* atio;
364 struct ccb_hdr *ccb_h;
366 softc = (struct targbh_softc *)periph->softc;
367 if ((softc->flags & TARGBH_FLAG_LUN_ENABLED) == 0)
370 /* XXX Block for Continue I/O completion */
372 /* Kill off all ACCECPT and IMMEDIATE CCBs */
373 while ((atio = softc->accept_tio_list) != NULL) {
375 softc->accept_tio_list =
376 ((struct targbh_cmd_desc*)atio->ccb_h.ccb_descr)->atio_link;
377 xpt_setup_ccb(&ccb.cab.ccb_h, periph->path, /*priority*/1);
378 ccb.cab.ccb_h.func_code = XPT_ABORT;
379 ccb.cab.abort_ccb = (union ccb *)atio;
383 while ((ccb_h = SLIST_FIRST(&softc->immed_notify_slist)) != NULL) {
384 SLIST_REMOVE_HEAD(&softc->immed_notify_slist, periph_links.sle);
385 xpt_setup_ccb(&ccb.cab.ccb_h, periph->path, /*priority*/1);
386 ccb.cab.ccb_h.func_code = XPT_ABORT;
387 ccb.cab.abort_ccb = (union ccb *)ccb_h;
394 xpt_setup_ccb(&ccb.cel.ccb_h, periph->path, /*priority*/1);
395 ccb.cel.ccb_h.func_code = XPT_EN_LUN;
399 if (ccb.cel.ccb_h.status != CAM_REQ_CMP)
400 printf("targbhdislun - Disabling lun on controller failed "
401 "with status 0x%x\n", ccb.cel.ccb_h.status);
403 softc->flags &= ~TARGBH_FLAG_LUN_ENABLED;
404 return (ccb.cel.ccb_h.status);
408 targbhctor(struct cam_periph *periph, void *arg)
410 struct targbh_softc *softc;
412 /* Allocate our per-instance private storage */
413 softc = (struct targbh_softc *)malloc(sizeof(*softc),
416 printf("targctor: unable to malloc softc\n");
417 return (CAM_REQ_CMP_ERR);
420 bzero(softc, sizeof(*softc));
421 TAILQ_INIT(&softc->pending_queue);
422 TAILQ_INIT(&softc->work_queue);
423 softc->accept_tio_list = NULL;
424 SLIST_INIT(&softc->immed_notify_slist);
425 softc->state = TARGBH_STATE_NORMAL;
426 periph->softc = softc;
429 return (targbhenlun(periph));
433 targbhdtor(struct cam_periph *periph)
435 struct targbh_softc *softc;
437 softc = (struct targbh_softc *)periph->softc;
439 softc->state = TARGBH_STATE_TEARDOWN;
441 targbhdislun(periph);
443 switch (softc->init_level) {
445 panic("targdtor - impossible init level");;
449 /* XXX Wait for callback of targbhdislun() */
450 tsleep(softc, PRIBIO, "targbh", hz/2);
451 free(softc, M_SCSIBH);
457 targbhstart(struct cam_periph *periph, union ccb *start_ccb)
459 struct targbh_softc *softc;
460 struct ccb_hdr *ccbh;
461 struct ccb_accept_tio *atio;
462 struct targbh_cmd_desc *desc;
463 struct ccb_scsiio *csio;
467 softc = (struct targbh_softc *)periph->softc;
470 ccbh = TAILQ_FIRST(&softc->work_queue);
471 if (periph->immediate_priority <= periph->pinfo.priority) {
472 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WAITING;
473 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
475 periph->immediate_priority = CAM_PRIORITY_NONE;
477 wakeup(&periph->ccb_list);
478 } else if (ccbh == NULL) {
480 xpt_release_ccb(start_ccb);
482 TAILQ_REMOVE(&softc->work_queue, ccbh, periph_links.tqe);
483 TAILQ_INSERT_HEAD(&softc->pending_queue, ccbh,
486 atio = (struct ccb_accept_tio*)ccbh;
487 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
489 /* Is this a tagged request? */
490 flags = atio->ccb_h.flags &
491 (CAM_DIS_DISCONNECT|CAM_TAG_ACTION_VALID|CAM_DIR_MASK);
493 csio = &start_ccb->csio;
495 * If we are done with the transaction, tell the
496 * controller to send status and perform a CMD_CMPLT.
497 * If we have associated sense data, see if we can
500 if (desc->data_resid == desc->data_increment) {
501 flags |= CAM_SEND_STATUS;
502 if (atio->sense_len) {
503 csio->sense_len = atio->sense_len;
504 csio->sense_data = atio->sense_data;
505 flags |= CAM_SEND_SENSE;
514 (flags & CAM_TAG_ACTION_VALID)?
515 MSG_SIMPLE_Q_TAG : 0,
519 /*data_ptr*/desc->data_increment == 0
521 /*dxfer_len*/desc->data_increment,
522 /*timeout*/desc->timeout);
524 /* Override our wildcard attachment */
525 start_ccb->ccb_h.target_id = atio->ccb_h.target_id;
526 start_ccb->ccb_h.target_lun = atio->ccb_h.target_lun;
528 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WORKQ;
529 start_ccb->ccb_h.ccb_atio = atio;
530 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
531 ("Sending a CTIO\n"));
532 xpt_action(start_ccb);
534 * If the queue was frozen waiting for the response
535 * to this ATIO (for instance disconnection was disallowed),
536 * then release it now that our response has been queued.
538 if ((atio->ccb_h.status & CAM_DEV_QFRZN) != 0) {
539 cam_release_devq(periph->path,
544 atio->ccb_h.status &= ~CAM_DEV_QFRZN;
547 ccbh = TAILQ_FIRST(&softc->work_queue);
551 xpt_schedule(periph, /*priority*/1);
555 targbhdone(struct cam_periph *periph, union ccb *done_ccb)
557 struct targbh_softc *softc;
559 softc = (struct targbh_softc *)periph->softc;
561 if (done_ccb->ccb_h.ccb_type == TARGBH_CCB_WAITING) {
562 /* Caller will release the CCB */
563 wakeup(&done_ccb->ccb_h.cbfcnp);
567 switch (done_ccb->ccb_h.func_code) {
568 case XPT_ACCEPT_TARGET_IO:
570 struct ccb_accept_tio *atio;
571 struct targbh_cmd_desc *descr;
575 atio = &done_ccb->atio;
576 descr = (struct targbh_cmd_desc*)atio->ccb_h.ccb_descr;
577 cdb = atio->cdb_io.cdb_bytes;
578 if (softc->state == TARGBH_STATE_TEARDOWN
579 || atio->ccb_h.status == CAM_REQ_ABORTED) {
580 targbhfreedescr(descr);
581 xpt_free_ccb(done_ccb);
586 * Determine the type of incoming command and
587 * setup our buffer for a response.
592 struct scsi_inquiry *inq;
594 inq = (struct scsi_inquiry *)cdb;
595 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
596 ("Saw an inquiry!\n"));
598 * Validate the command. We don't
599 * support any VPD pages, so complain
602 if ((inq->byte2 & SI_EVPD) != 0
603 || inq->page_code != 0) {
604 atio->ccb_h.flags &= ~CAM_DIR_MASK;
605 atio->ccb_h.flags |= CAM_DIR_NONE;
607 * This needs to have other than a
608 * no_lun_sense_data response.
610 atio->sense_data = no_lun_sense_data;
611 atio->sense_len = sizeof(no_lun_sense_data);
612 descr->data_resid = 0;
613 descr->data_increment = 0;
614 descr->status = SCSI_STATUS_CHECK_COND;
618 * Direction is always relative
621 atio->ccb_h.flags &= ~CAM_DIR_MASK;
622 atio->ccb_h.flags |= CAM_DIR_IN;
623 descr->data = &no_lun_inq_data;
624 descr->data_resid = MIN(sizeof(no_lun_inq_data),
625 SCSI_CDB6_LEN(inq->length));
626 descr->data_increment = descr->data_resid;
627 descr->timeout = 5 * 1000;
628 descr->status = SCSI_STATUS_OK;
633 struct scsi_request_sense *rsense;
635 rsense = (struct scsi_request_sense *)cdb;
636 /* Refer to static sense data */
637 atio->ccb_h.flags &= ~CAM_DIR_MASK;
638 atio->ccb_h.flags |= CAM_DIR_IN;
639 descr->data = &no_lun_sense_data;
640 descr->data_resid = request_sense_size;
641 descr->data_resid = MIN(descr->data_resid,
642 SCSI_CDB6_LEN(rsense->length));
643 descr->data_increment = descr->data_resid;
644 descr->timeout = 5 * 1000;
645 descr->status = SCSI_STATUS_OK;
649 /* Constant CA, tell initiator */
650 /* Direction is always relative to the initator */
651 atio->ccb_h.flags &= ~CAM_DIR_MASK;
652 atio->ccb_h.flags |= CAM_DIR_NONE;
653 atio->sense_data = no_lun_sense_data;
654 atio->sense_len = sizeof (no_lun_sense_data);
655 descr->data_resid = 0;
656 descr->data_increment = 0;
657 descr->timeout = 5 * 1000;
658 descr->status = SCSI_STATUS_CHECK_COND;
662 /* Queue us up to receive a Continue Target I/O ccb. */
663 if ((atio->ccb_h.flags & CAM_DIS_DISCONNECT) != 0) {
664 TAILQ_INSERT_HEAD(&softc->work_queue, &atio->ccb_h,
668 TAILQ_INSERT_TAIL(&softc->work_queue, &atio->ccb_h,
672 xpt_schedule(periph, priority);
675 case XPT_CONT_TARGET_IO:
677 struct ccb_accept_tio *atio;
678 struct targbh_cmd_desc *desc;
680 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
681 ("Received completed CTIO\n"));
682 atio = (struct ccb_accept_tio*)done_ccb->ccb_h.ccb_atio;
683 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
685 TAILQ_REMOVE(&softc->pending_queue, &atio->ccb_h,
689 * We could check for CAM_SENT_SENSE bein set here,
690 * but since we're not maintaining any CA/UA state,
694 done_ccb->ccb_h.flags &= ~CAM_SEND_SENSE;
695 done_ccb->ccb_h.status &= ~CAM_SENT_SENSE;
698 * Any errors will not change the data we return,
699 * so make sure the queue is not left frozen.
700 * XXX - At some point there may be errors that
701 * leave us in a connected state with the
704 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
705 printf("Releasing Queue\n");
706 cam_release_devq(done_ccb->ccb_h.path,
711 done_ccb->ccb_h.status &= ~CAM_DEV_QFRZN;
713 desc->data_resid -= desc->data_increment;
714 xpt_release_ccb(done_ccb);
715 if (softc->state != TARGBH_STATE_TEARDOWN) {
718 * Send the original accept TIO back to the
719 * controller to handle more work.
721 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
722 ("Returning ATIO to target\n"));
723 /* Restore wildcards */
724 atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
725 atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
726 xpt_action((union ccb *)atio);
729 targbhfreedescr(desc);
730 free(atio, M_SCSIBH);
734 case XPT_IMMED_NOTIFY:
738 frozen = (done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0;
739 if (softc->state == TARGBH_STATE_TEARDOWN
740 || done_ccb->ccb_h.status == CAM_REQ_ABORTED) {
741 printf("Freed an immediate notify\n");
742 xpt_free_ccb(done_ccb);
744 /* Requeue for another immediate event */
745 xpt_action(done_ccb);
748 cam_release_devq(periph->path,
750 /*opening reduction*/0,
756 panic("targbhdone: Unexpected ccb opcode");
763 targbherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
769 static struct targbh_cmd_desc*
772 struct targbh_cmd_desc* descr;
774 /* Allocate the targbh_descr structure */
775 descr = (struct targbh_cmd_desc *)malloc(sizeof(*descr),
780 bzero(descr, sizeof(*descr));
782 /* Allocate buffer backing store */
783 descr->backing_store = malloc(MAX_BUF_SIZE, M_SCSIBH, M_NOWAIT);
784 if (descr->backing_store == NULL) {
785 free(descr, M_SCSIBH);
788 descr->max_size = MAX_BUF_SIZE;
793 targbhfreedescr(struct targbh_cmd_desc *descr)
795 free(descr->backing_store, M_SCSIBH);
796 free(descr, M_SCSIBH);