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
30 #include <stddef.h> /* For offsetof */
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_extend.h>
46 #include <cam/cam_periph.h>
47 #include <cam/cam_queue.h>
48 #include <cam/cam_xpt_periph.h>
49 #include <cam/cam_debug.h>
51 #include <cam/scsi/scsi_all.h>
52 #include <cam/scsi/scsi_message.h>
56 TARGBH_STATE_EXCEPTION,
61 TARGBH_FLAG_NONE = 0x00,
62 TARGBH_FLAG_LUN_ENABLED = 0x01
71 #define MAX_IMMEDIATE 16
72 #define MAX_BUF_SIZE 256 /* Max inquiry/sense/mode page transfer */
74 #define MIN(a, b) ((a > b) ? b : a)
76 /* Offsets into our private CCB area for storing accept information */
77 #define ccb_type ppriv_field0
78 #define ccb_descr ppriv_ptr1
80 /* We stick a pointer to the originating accept TIO in each continue I/O CCB */
81 #define ccb_atio ppriv_ptr1
83 TAILQ_HEAD(ccb_queue, ccb_hdr);
86 struct ccb_queue pending_queue;
87 struct ccb_queue work_queue;
88 struct ccb_queue unknown_atio_queue;
89 struct devstat device_stats;
94 struct ccb_accept_tio *accept_tio_list;
95 struct ccb_hdr_slist immed_notify_slist;
98 struct targbh_cmd_desc {
99 struct ccb_accept_tio* atio_link;
100 u_int data_resid; /* How much left to transfer */
101 u_int data_increment;/* Amount to send before next disconnect */
102 void* data; /* The data. Can be from backing_store or not */
103 void* backing_store;/* Backing store allocated for this descriptor*/
104 u_int max_size; /* Size of backing_store */
106 u_int8_t status; /* Status to return to initiator */
109 static struct scsi_inquiry_data no_lun_inq_data =
111 T_NODEVICE | (SID_QUAL_BAD_LU << 5), 0,
112 /* version */2, /* format version */2
115 static struct scsi_sense_data no_lun_sense_data =
117 SSD_CURRENT_ERROR|SSD_ERRCODE_VALID,
121 /*extra_len*/offsetof(struct scsi_sense_data, fru)
122 - offsetof(struct scsi_sense_data, extra_len),
124 /* Logical Unit Not Supported */
125 /*ASC*/0x25, /*ASCQ*/0
128 static const int request_sense_size = offsetof(struct scsi_sense_data, fru);
130 static periph_init_t targbhinit;
131 static void targbhasync(void *callback_arg, u_int32_t code,
132 struct cam_path *path, void *arg);
133 static cam_status targbhenlun(struct cam_periph *periph);
134 static cam_status targbhdislun(struct cam_periph *periph);
135 static periph_ctor_t targbhctor;
136 static periph_dtor_t targbhdtor;
137 static periph_start_t targbhstart;
138 static void targbhdone(struct cam_periph *periph,
139 union ccb *done_ccb);
141 static int targbherror(union ccb *ccb, u_int32_t cam_flags,
142 u_int32_t sense_flags);
144 static struct targbh_cmd_desc* targbhallocdescr(void);
145 static void targbhfreedescr(struct targbh_cmd_desc *buf);
147 static struct periph_driver targbhdriver =
149 targbhinit, "targbh",
150 TAILQ_HEAD_INITIALIZER(targbhdriver.units), /* generation */ 0
153 DATA_SET(periphdriver_set, targbhdriver);
159 struct cam_path *path;
162 * Install a global async callback. This callback will
163 * receive async callbacks like "new path registered".
165 status = xpt_create_path(&path, /*periph*/NULL, CAM_XPT_PATH_ID,
166 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
168 if (status == CAM_REQ_CMP) {
169 struct ccb_setasync csa;
171 xpt_setup_ccb(&csa.ccb_h, path, /*priority*/5);
172 csa.ccb_h.func_code = XPT_SASYNC_CB;
173 csa.event_enable = AC_PATH_REGISTERED;
174 csa.callback = targbhasync;
175 csa.callback_arg = NULL;
176 xpt_action((union ccb *)&csa);
177 status = csa.ccb_h.status;
181 if (status != CAM_REQ_CMP) {
182 printf("targbh: Failed to attach master async callback "
183 "due to status 0x%x!\n", status);
188 targbhasync(void *callback_arg, u_int32_t code,
189 struct cam_path *path, void *arg)
191 struct cam_periph *periph;
193 periph = (struct cam_periph *)callback_arg;
195 case AC_PATH_REGISTERED:
197 struct ccb_pathinq *cpi;
198 struct cam_path *new_path;
201 cpi = (struct ccb_pathinq *)arg;
203 /* Only attach to controllers that support target mode */
204 if ((cpi->target_sprt & PIT_PROCESSOR) == 0)
208 * Allocate a peripheral instance for
209 * this target instance.
211 status = xpt_create_path(&new_path, NULL,
212 xpt_path_path_id(path),
213 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
214 if (status != CAM_REQ_CMP) {
215 printf("targbhasync: Unable to create path "
216 "due to status 0x%x\n", status);
219 status = cam_periph_alloc(targbhctor, NULL, targbhdtor,
221 "targbh", CAM_PERIPH_BIO,
222 new_path, targbhasync,
225 xpt_free_path(new_path);
226 if (status != CAM_REQ_CMP
227 && status != CAM_REQ_INPROG)
228 printf("targbhasync: Unable to allocate new periph "
229 "due to status 0x%x\n", status);
232 case AC_PATH_DEREGISTERED:
234 targbhdislun(periph);
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_path(periph->path);
267 printf("targbhenlun - Enable Lun Rejected for 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_DEVBUF,
284 status = CAM_RESRC_UNAVAIL;
288 atio->ccb_h.ccb_descr = targbhallocdescr();
290 if (atio->ccb_h.ccb_descr == NULL) {
291 free(atio, M_DEVBUF);
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_DEVBUF);
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_path(periph->path);
313 printf("targbhenlun - Could not allocate accept tio CCBs: "
314 "status = 0x%x\n", 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_DEVBUF,
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_DEVBUF);
343 SLIST_INSERT_HEAD(&softc->immed_notify_slist, &inot->ccb_h,
348 xpt_print_path(periph->path);
349 printf("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 ccb_pathinq *cpi;
411 struct targbh_softc *softc;
413 cpi = (struct ccb_pathinq *)arg;
415 /* Allocate our per-instance private storage */
416 softc = (struct targbh_softc *)malloc(sizeof(*softc),
419 printf("targctor: unable to malloc softc\n");
420 return (CAM_REQ_CMP_ERR);
423 bzero(softc, sizeof(softc));
424 TAILQ_INIT(&softc->pending_queue);
425 TAILQ_INIT(&softc->work_queue);
426 softc->accept_tio_list = NULL;
427 SLIST_INIT(&softc->immed_notify_slist);
428 softc->state = TARGBH_STATE_NORMAL;
429 periph->softc = softc;
432 return (targbhenlun(periph));
436 targbhdtor(struct cam_periph *periph)
438 struct targbh_softc *softc;
440 softc = (struct targbh_softc *)periph->softc;
442 softc->state = TARGBH_STATE_TEARDOWN;
444 targbhdislun(periph);
446 switch (softc->init_level) {
450 free(softc, M_DEVBUF);
453 panic("targdtor - impossible init level");;
458 targbhstart(struct cam_periph *periph, union ccb *start_ccb)
460 struct targbh_softc *softc;
461 struct ccb_hdr *ccbh;
462 struct ccb_accept_tio *atio;
463 struct targbh_cmd_desc *desc;
464 struct ccb_scsiio *csio;
468 softc = (struct targbh_softc *)periph->softc;
471 ccbh = TAILQ_FIRST(&softc->work_queue);
472 if (periph->immediate_priority <= periph->pinfo.priority) {
473 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WAITING;
474 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
476 periph->immediate_priority = CAM_PRIORITY_NONE;
478 wakeup(&periph->ccb_list);
479 } else if (ccbh == NULL) {
481 xpt_release_ccb(start_ccb);
483 TAILQ_REMOVE(&softc->work_queue, ccbh, periph_links.tqe);
484 TAILQ_INSERT_HEAD(&softc->pending_queue, ccbh,
487 atio = (struct ccb_accept_tio*)ccbh;
488 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
490 /* Is this a tagged request? */
491 flags = atio->ccb_h.flags & (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 /*tag_action*/MSG_SIMPLE_Q_TAG,
518 /*data_ptr*/desc->data_increment == 0
520 /*dxfer_len*/desc->data_increment,
521 /*timeout*/desc->timeout);
523 /* Override our wildcard attachment */
524 start_ccb->ccb_h.target_id = atio->ccb_h.target_id;
525 start_ccb->ccb_h.target_lun = atio->ccb_h.target_lun;
527 start_ccb->ccb_h.ccb_type = TARGBH_CCB_WORKQ;
528 start_ccb->ccb_h.ccb_atio = atio;
529 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
530 ("Sending a CTIO\n"));
531 xpt_action(start_ccb);
533 ccbh = TAILQ_FIRST(&softc->work_queue);
537 xpt_schedule(periph, /*priority*/1);
541 targbhdone(struct cam_periph *periph, union ccb *done_ccb)
543 struct targbh_softc *softc;
545 softc = (struct targbh_softc *)periph->softc;
547 if (done_ccb->ccb_h.ccb_type == TARGBH_CCB_WAITING) {
548 /* Caller will release the CCB */
549 wakeup(&done_ccb->ccb_h.cbfcnp);
553 switch (done_ccb->ccb_h.func_code) {
554 case XPT_ACCEPT_TARGET_IO:
556 struct ccb_accept_tio *atio;
557 struct targbh_cmd_desc *descr;
560 atio = &done_ccb->atio;
561 descr = (struct targbh_cmd_desc*)atio->ccb_h.ccb_descr;
562 cdb = atio->cdb_io.cdb_bytes;
563 if (softc->state == TARGBH_STATE_TEARDOWN
564 || atio->ccb_h.status == CAM_REQ_ABORTED) {
565 targbhfreedescr(descr);
566 free(done_ccb, M_DEVBUF);
571 * Determine the type of incoming command and
572 * setup our buffer for a response.
577 struct scsi_inquiry *inq;
579 inq = (struct scsi_inquiry *)cdb;
580 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
581 ("Saw an inquiry!\n"));
583 * Validate the command. We don't
584 * support any VPD pages, so complain
587 if ((inq->byte2 & SI_EVPD) != 0
588 || inq->page_code != 0) {
589 atio->ccb_h.flags &= ~CAM_DIR_MASK;
590 atio->ccb_h.flags |= CAM_DIR_NONE;
592 * This needs to have other than a
593 * no_lun_sense_data response.
595 atio->sense_data = no_lun_sense_data;
596 atio->sense_len = sizeof (no_lun_sense_data);
597 descr->data_resid = 0;
598 descr->data_increment = 0;
599 descr->status = SCSI_STATUS_CHECK_COND;
603 * Direction is always relative
606 atio->ccb_h.flags &= ~CAM_DIR_MASK;
607 atio->ccb_h.flags |= CAM_DIR_IN;
608 descr->data = &no_lun_inq_data;
609 descr->data_resid = MIN(sizeof(no_lun_inq_data),
611 descr->data_increment = descr->data_resid;
612 descr->timeout = 5 * 1000;
613 descr->status = SCSI_STATUS_OK;
618 struct scsi_request_sense *rsense;
620 rsense = (struct scsi_request_sense *)cdb;
621 /* Refer to static sense data */
622 atio->ccb_h.flags &= ~CAM_DIR_MASK;
623 atio->ccb_h.flags |= CAM_DIR_IN;
624 descr->data = &no_lun_sense_data;
625 descr->data_resid = request_sense_size;
626 descr->data_resid = MIN(descr->data_resid,
628 descr->data_increment = descr->data_resid;
629 descr->timeout = 5 * 1000;
630 descr->status = SCSI_STATUS_OK;
634 /* Constant CA, tell initiator */
635 /* Direction is always relative to the initator */
636 atio->ccb_h.flags &= ~CAM_DIR_MASK;
637 atio->ccb_h.flags |= CAM_DIR_NONE;
638 atio->sense_data = no_lun_sense_data;
639 atio->sense_len = sizeof (no_lun_sense_data);
640 descr->data_resid = 0;
641 descr->data_increment = 0;
642 descr->timeout = 5 * 1000;
643 descr->status = SCSI_STATUS_CHECK_COND;
647 /* Queue us up to receive a Continue Target I/O ccb. */
648 TAILQ_INSERT_TAIL(&softc->work_queue, &atio->ccb_h,
650 xpt_schedule(periph, /*priority*/1);
653 case XPT_CONT_TARGET_IO:
655 struct ccb_accept_tio *atio;
656 struct targbh_cmd_desc *desc;
658 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
659 ("Received completed CTIO\n"));
660 atio = (struct ccb_accept_tio*)done_ccb->ccb_h.ccb_atio;
661 desc = (struct targbh_cmd_desc *)atio->ccb_h.ccb_descr;
663 TAILQ_REMOVE(&softc->pending_queue, &atio->ccb_h,
667 * We could check for CAM_SENT_SENSE bein set here,
668 * but since we're not maintaining any CA/UA state,
672 done_ccb->ccb_h.flags &= ~CAM_SEND_SENSE;
673 done_ccb->ccb_h.status &= ~CAM_SENT_SENSE;
675 /* XXX Check for errors */
676 desc->data_resid -= desc->data_increment;
677 xpt_release_ccb(done_ccb);
678 if (softc->state != TARGBH_STATE_TEARDOWN) {
681 * Send the original accept TIO back to the
682 * controller to handle more work.
684 CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
685 ("Returning ATIO to target\n"));
686 /* Restore wildcards */
687 atio->ccb_h.target_id = CAM_TARGET_WILDCARD;
688 atio->ccb_h.target_lun = CAM_LUN_WILDCARD;
689 xpt_action((union ccb *)atio);
692 targbhfreedescr(desc);
693 free(atio, M_DEVBUF);
697 case XPT_IMMED_NOTIFY:
699 if (softc->state == TARGBH_STATE_TEARDOWN
700 || done_ccb->ccb_h.status == CAM_REQ_ABORTED) {
701 printf("Freed an immediate notify\n");
702 free(done_ccb, M_DEVBUF);
707 panic("targbhdone: Unexpected ccb opcode");
714 targbherror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
720 static struct targbh_cmd_desc*
723 struct targbh_cmd_desc* descr;
725 /* Allocate the targbh_descr structure */
726 descr = (struct targbh_cmd_desc *)malloc(sizeof(*descr),
731 bzero(descr, sizeof(*descr));
733 /* Allocate buffer backing store */
734 descr->backing_store = malloc(MAX_BUF_SIZE, M_DEVBUF, M_NOWAIT);
735 if (descr->backing_store == NULL) {
736 free(descr, M_DEVBUF);
739 descr->max_size = MAX_BUF_SIZE;
744 targbhfreedescr(struct targbh_cmd_desc *descr)
746 free(descr->backing_store, M_DEVBUF);
747 free(descr, M_DEVBUF);