1 /*******************************************************************************
3 * This file contains the Linux/SCSI LLD virtual SCSI initiator driver
4 * for emulated SAS initiator ports
6 * © Copyright 2011 RisingTide Systems LLC.
8 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
10 * Author: Nicholas A. Bellinger <nab@risingtidesystems.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 ****************************************************************************/
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/init.h>
26 #include <linux/slab.h>
27 #include <linux/types.h>
28 #include <linux/configfs.h>
29 #include <scsi/scsi.h>
30 #include <scsi/scsi_tcq.h>
31 #include <scsi/scsi_host.h>
32 #include <scsi/scsi_device.h>
33 #include <scsi/scsi_cmnd.h>
35 #include <target/target_core_base.h>
36 #include <target/target_core_fabric.h>
37 #include <target/target_core_fabric_configfs.h>
38 #include <target/target_core_configfs.h>
42 #define to_tcm_loop_hba(hba) container_of(hba, struct tcm_loop_hba, dev)
44 /* Local pointer to allocated TCM configfs fabric module */
45 static struct target_fabric_configfs *tcm_loop_fabric_configfs;
47 static struct workqueue_struct *tcm_loop_workqueue;
48 static struct kmem_cache *tcm_loop_cmd_cache;
50 static int tcm_loop_hba_no_cnt;
52 static int tcm_loop_queue_status(struct se_cmd *se_cmd);
55 * Called from struct target_core_fabric_ops->check_stop_free()
57 static int tcm_loop_check_stop_free(struct se_cmd *se_cmd)
60 * Do not release struct se_cmd's containing a valid TMR
61 * pointer. These will be released directly in tcm_loop_device_reset()
62 * with transport_generic_free_cmd().
64 if (se_cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)
67 * Release the struct se_cmd, which will make a callback to release
68 * struct tcm_loop_cmd * in tcm_loop_deallocate_core_cmd()
70 transport_generic_free_cmd(se_cmd, 0);
74 static void tcm_loop_release_cmd(struct se_cmd *se_cmd)
76 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
77 struct tcm_loop_cmd, tl_se_cmd);
79 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
82 static int tcm_loop_show_info(struct seq_file *m, struct Scsi_Host *host)
84 seq_printf(m, "tcm_loop_proc_info()\n");
88 static int tcm_loop_driver_probe(struct device *);
89 static int tcm_loop_driver_remove(struct device *);
91 static int pseudo_lld_bus_match(struct device *dev,
92 struct device_driver *dev_driver)
97 static struct bus_type tcm_loop_lld_bus = {
98 .name = "tcm_loop_bus",
99 .match = pseudo_lld_bus_match,
100 .probe = tcm_loop_driver_probe,
101 .remove = tcm_loop_driver_remove,
104 static struct device_driver tcm_loop_driverfs = {
106 .bus = &tcm_loop_lld_bus,
109 * Used with root_device_register() in tcm_loop_alloc_core_bus() below
111 struct device *tcm_loop_primary;
114 * Copied from drivers/scsi/libfc/fc_fcp.c:fc_change_queue_depth() and
115 * drivers/scsi/libiscsi.c:iscsi_change_queue_depth()
117 static int tcm_loop_change_queue_depth(
118 struct scsi_device *sdev,
123 case SCSI_QDEPTH_DEFAULT:
124 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
126 case SCSI_QDEPTH_QFULL:
127 scsi_track_queue_full(sdev, depth);
129 case SCSI_QDEPTH_RAMP_UP:
130 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
135 return sdev->queue_depth;
139 * Locate the SAM Task Attr from struct scsi_cmnd *
141 static int tcm_loop_sam_attr(struct scsi_cmnd *sc)
143 if (sc->device->tagged_supported) {
145 case HEAD_OF_QUEUE_TAG:
147 case ORDERED_QUEUE_TAG:
148 return MSG_ORDERED_TAG;
154 return MSG_SIMPLE_TAG;
157 static void tcm_loop_submission_work(struct work_struct *work)
159 struct tcm_loop_cmd *tl_cmd =
160 container_of(work, struct tcm_loop_cmd, work);
161 struct se_cmd *se_cmd = &tl_cmd->tl_se_cmd;
162 struct scsi_cmnd *sc = tl_cmd->sc;
163 struct tcm_loop_nexus *tl_nexus;
164 struct tcm_loop_hba *tl_hba;
165 struct tcm_loop_tpg *tl_tpg;
166 struct scatterlist *sgl_bidi = NULL;
167 u32 sgl_bidi_count = 0;
170 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
171 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
174 * Ensure that this tl_tpg reference from the incoming sc->device->id
175 * has already been configured via tcm_loop_make_naa_tpg().
177 if (!tl_tpg->tl_hba) {
178 set_host_byte(sc, DID_NO_CONNECT);
182 tl_nexus = tl_hba->tl_nexus;
184 scmd_printk(KERN_ERR, sc, "TCM_Loop I_T Nexus"
185 " does not exist\n");
186 set_host_byte(sc, DID_ERROR);
189 if (scsi_bidi_cmnd(sc)) {
190 struct scsi_data_buffer *sdb = scsi_in(sc);
192 sgl_bidi = sdb->table.sgl;
193 sgl_bidi_count = sdb->table.nents;
194 se_cmd->se_cmd_flags |= SCF_BIDI;
197 rc = target_submit_cmd_map_sgls(se_cmd, tl_nexus->se_sess, sc->cmnd,
198 &tl_cmd->tl_sense_buf[0], tl_cmd->sc->device->lun,
199 scsi_bufflen(sc), tcm_loop_sam_attr(sc),
200 sc->sc_data_direction, 0,
201 scsi_sglist(sc), scsi_sg_count(sc),
202 sgl_bidi, sgl_bidi_count);
204 set_host_byte(sc, DID_NO_CONNECT);
215 * ->queuecommand can be and usually is called from interrupt context, so
216 * defer the actual submission to a workqueue.
218 static int tcm_loop_queuecommand(struct Scsi_Host *sh, struct scsi_cmnd *sc)
220 struct tcm_loop_cmd *tl_cmd;
222 pr_debug("tcm_loop_queuecommand() %d:%d:%d:%d got CDB: 0x%02x"
223 " scsi_buf_len: %u\n", sc->device->host->host_no,
224 sc->device->id, sc->device->channel, sc->device->lun,
225 sc->cmnd[0], scsi_bufflen(sc));
227 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC);
229 pr_err("Unable to allocate struct tcm_loop_cmd\n");
230 set_host_byte(sc, DID_ERROR);
236 INIT_WORK(&tl_cmd->work, tcm_loop_submission_work);
237 queue_work(tcm_loop_workqueue, &tl_cmd->work);
242 * Called from SCSI EH process context to issue a LUN_RESET TMR
243 * to struct scsi_device
245 static int tcm_loop_device_reset(struct scsi_cmnd *sc)
247 struct se_cmd *se_cmd = NULL;
248 struct se_portal_group *se_tpg;
249 struct se_session *se_sess;
250 struct tcm_loop_cmd *tl_cmd = NULL;
251 struct tcm_loop_hba *tl_hba;
252 struct tcm_loop_nexus *tl_nexus;
253 struct tcm_loop_tmr *tl_tmr = NULL;
254 struct tcm_loop_tpg *tl_tpg;
255 int ret = FAILED, rc;
257 * Locate the tcm_loop_hba_t pointer
259 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
261 * Locate the tl_nexus and se_sess pointers
263 tl_nexus = tl_hba->tl_nexus;
265 pr_err("Unable to perform device reset without"
266 " active I_T Nexus\n");
269 se_sess = tl_nexus->se_sess;
271 * Locate the tl_tpg and se_tpg pointers from TargetID in sc->device->id
273 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
274 se_tpg = &tl_tpg->tl_se_tpg;
276 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL);
278 pr_err("Unable to allocate memory for tl_cmd\n");
282 tl_tmr = kzalloc(sizeof(struct tcm_loop_tmr), GFP_KERNEL);
284 pr_err("Unable to allocate memory for tl_tmr\n");
287 init_waitqueue_head(&tl_tmr->tl_tmr_wait);
289 se_cmd = &tl_cmd->tl_se_cmd;
291 * Initialize struct se_cmd descriptor from target_core_mod infrastructure
293 transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess, 0,
294 DMA_NONE, MSG_SIMPLE_TAG,
295 &tl_cmd->tl_sense_buf[0]);
297 rc = core_tmr_alloc_req(se_cmd, tl_tmr, TMR_LUN_RESET, GFP_KERNEL);
301 * Locate the underlying TCM struct se_lun from sc->device->lun
303 if (transport_lookup_tmr_lun(se_cmd, sc->device->lun) < 0)
306 * Queue the TMR to TCM Core and sleep waiting for tcm_loop_queue_tm_rsp()
309 transport_generic_handle_tmr(se_cmd);
310 wait_event(tl_tmr->tl_tmr_wait, atomic_read(&tl_tmr->tmr_complete));
312 * The TMR LUN_RESET has completed, check the response status and
313 * then release allocations.
315 ret = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
319 transport_generic_free_cmd(se_cmd, 1);
321 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
326 static int tcm_loop_slave_alloc(struct scsi_device *sd)
328 set_bit(QUEUE_FLAG_BIDI, &sd->request_queue->queue_flags);
332 static int tcm_loop_slave_configure(struct scsi_device *sd)
337 static struct scsi_host_template tcm_loop_driver_template = {
338 .show_info = tcm_loop_show_info,
339 .proc_name = "tcm_loopback",
340 .name = "TCM_Loopback",
341 .queuecommand = tcm_loop_queuecommand,
342 .change_queue_depth = tcm_loop_change_queue_depth,
343 .eh_device_reset_handler = tcm_loop_device_reset,
348 .max_sectors = 0xFFFF,
349 .use_clustering = DISABLE_CLUSTERING,
350 .slave_alloc = tcm_loop_slave_alloc,
351 .slave_configure = tcm_loop_slave_configure,
352 .module = THIS_MODULE,
355 static int tcm_loop_driver_probe(struct device *dev)
357 struct tcm_loop_hba *tl_hba;
358 struct Scsi_Host *sh;
361 tl_hba = to_tcm_loop_hba(dev);
363 sh = scsi_host_alloc(&tcm_loop_driver_template,
364 sizeof(struct tcm_loop_hba));
366 pr_err("Unable to allocate struct scsi_host\n");
372 * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata
374 *((struct tcm_loop_hba **)sh->hostdata) = tl_hba;
376 * Setup single ID, Channel and LUN for now..
381 sh->max_cmd_len = TL_SCSI_MAX_CMD_LEN;
383 error = scsi_add_host(sh, &tl_hba->dev);
385 pr_err("%s: scsi_add_host failed\n", __func__);
392 static int tcm_loop_driver_remove(struct device *dev)
394 struct tcm_loop_hba *tl_hba;
395 struct Scsi_Host *sh;
397 tl_hba = to_tcm_loop_hba(dev);
400 scsi_remove_host(sh);
405 static void tcm_loop_release_adapter(struct device *dev)
407 struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev);
413 * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c
415 static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id)
419 tl_hba->dev.bus = &tcm_loop_lld_bus;
420 tl_hba->dev.parent = tcm_loop_primary;
421 tl_hba->dev.release = &tcm_loop_release_adapter;
422 dev_set_name(&tl_hba->dev, "tcm_loop_adapter_%d", tcm_loop_host_id);
424 ret = device_register(&tl_hba->dev);
426 pr_err("device_register() failed for"
427 " tl_hba->dev: %d\n", ret);
435 * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated
438 static int tcm_loop_alloc_core_bus(void)
442 tcm_loop_primary = root_device_register("tcm_loop_0");
443 if (IS_ERR(tcm_loop_primary)) {
444 pr_err("Unable to allocate tcm_loop_primary\n");
445 return PTR_ERR(tcm_loop_primary);
448 ret = bus_register(&tcm_loop_lld_bus);
450 pr_err("bus_register() failed for tcm_loop_lld_bus\n");
454 ret = driver_register(&tcm_loop_driverfs);
456 pr_err("driver_register() failed for"
457 "tcm_loop_driverfs\n");
461 pr_debug("Initialized TCM Loop Core Bus\n");
465 bus_unregister(&tcm_loop_lld_bus);
467 root_device_unregister(tcm_loop_primary);
471 static void tcm_loop_release_core_bus(void)
473 driver_unregister(&tcm_loop_driverfs);
474 bus_unregister(&tcm_loop_lld_bus);
475 root_device_unregister(tcm_loop_primary);
477 pr_debug("Releasing TCM Loop Core BUS\n");
480 static char *tcm_loop_get_fabric_name(void)
485 static u8 tcm_loop_get_fabric_proto_ident(struct se_portal_group *se_tpg)
487 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
488 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
490 * tl_proto_id is set at tcm_loop_configfs.c:tcm_loop_make_scsi_hba()
491 * time based on the protocol dependent prefix of the passed configfs group.
493 * Based upon tl_proto_id, TCM_Loop emulates the requested fabric
494 * ProtocolID using target_core_fabric_lib.c symbols.
496 switch (tl_hba->tl_proto_id) {
497 case SCSI_PROTOCOL_SAS:
498 return sas_get_fabric_proto_ident(se_tpg);
499 case SCSI_PROTOCOL_FCP:
500 return fc_get_fabric_proto_ident(se_tpg);
501 case SCSI_PROTOCOL_ISCSI:
502 return iscsi_get_fabric_proto_ident(se_tpg);
504 pr_err("Unknown tl_proto_id: 0x%02x, using"
505 " SAS emulation\n", tl_hba->tl_proto_id);
509 return sas_get_fabric_proto_ident(se_tpg);
512 static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg)
514 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
516 * Return the passed NAA identifier for the SAS Target Port
518 return &tl_tpg->tl_hba->tl_wwn_address[0];
521 static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg)
523 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
525 * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83
526 * to represent the SCSI Target Port.
528 return tl_tpg->tl_tpgt;
531 static u32 tcm_loop_get_default_depth(struct se_portal_group *se_tpg)
536 static u32 tcm_loop_get_pr_transport_id(
537 struct se_portal_group *se_tpg,
538 struct se_node_acl *se_nacl,
539 struct t10_pr_registration *pr_reg,
543 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
544 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
546 switch (tl_hba->tl_proto_id) {
547 case SCSI_PROTOCOL_SAS:
548 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
550 case SCSI_PROTOCOL_FCP:
551 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
553 case SCSI_PROTOCOL_ISCSI:
554 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
557 pr_err("Unknown tl_proto_id: 0x%02x, using"
558 " SAS emulation\n", tl_hba->tl_proto_id);
562 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
566 static u32 tcm_loop_get_pr_transport_id_len(
567 struct se_portal_group *se_tpg,
568 struct se_node_acl *se_nacl,
569 struct t10_pr_registration *pr_reg,
572 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
573 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
575 switch (tl_hba->tl_proto_id) {
576 case SCSI_PROTOCOL_SAS:
577 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
579 case SCSI_PROTOCOL_FCP:
580 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
582 case SCSI_PROTOCOL_ISCSI:
583 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
586 pr_err("Unknown tl_proto_id: 0x%02x, using"
587 " SAS emulation\n", tl_hba->tl_proto_id);
591 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
596 * Used for handling SCSI fabric dependent TransportIDs in SPC-3 and above
597 * Persistent Reservation SPEC_I_PT=1 and PROUT REGISTER_AND_MOVE operations.
599 static char *tcm_loop_parse_pr_out_transport_id(
600 struct se_portal_group *se_tpg,
603 char **port_nexus_ptr)
605 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
606 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
608 switch (tl_hba->tl_proto_id) {
609 case SCSI_PROTOCOL_SAS:
610 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
612 case SCSI_PROTOCOL_FCP:
613 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
615 case SCSI_PROTOCOL_ISCSI:
616 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
619 pr_err("Unknown tl_proto_id: 0x%02x, using"
620 " SAS emulation\n", tl_hba->tl_proto_id);
624 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
629 * Returning (1) here allows for target_core_mod struct se_node_acl to be generated
630 * based upon the incoming fabric dependent SCSI Initiator Port
632 static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg)
637 static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg)
643 * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for
644 * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest
646 static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg)
652 * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will
653 * never be called for TCM_Loop by target_core_fabric_configfs.c code.
654 * It has been added here as a nop for target_fabric_tf_ops_check()
656 static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg)
661 static struct se_node_acl *tcm_loop_tpg_alloc_fabric_acl(
662 struct se_portal_group *se_tpg)
664 struct tcm_loop_nacl *tl_nacl;
666 tl_nacl = kzalloc(sizeof(struct tcm_loop_nacl), GFP_KERNEL);
668 pr_err("Unable to allocate struct tcm_loop_nacl\n");
672 return &tl_nacl->se_node_acl;
675 static void tcm_loop_tpg_release_fabric_acl(
676 struct se_portal_group *se_tpg,
677 struct se_node_acl *se_nacl)
679 struct tcm_loop_nacl *tl_nacl = container_of(se_nacl,
680 struct tcm_loop_nacl, se_node_acl);
685 static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg)
690 static u32 tcm_loop_sess_get_index(struct se_session *se_sess)
695 static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl)
700 static u32 tcm_loop_get_task_tag(struct se_cmd *se_cmd)
705 static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd)
707 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
708 struct tcm_loop_cmd, tl_se_cmd);
710 return tl_cmd->sc_cmd_state;
713 static int tcm_loop_shutdown_session(struct se_session *se_sess)
718 static void tcm_loop_close_session(struct se_session *se_sess)
723 static int tcm_loop_write_pending(struct se_cmd *se_cmd)
726 * Since Linux/SCSI has already sent down a struct scsi_cmnd
727 * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array
728 * memory, and memory has already been mapped to struct se_cmd->t_mem_list
729 * format with transport_generic_map_mem_to_cmd().
731 * We now tell TCM to add this WRITE CDB directly into the TCM storage
732 * object execution queue.
734 target_execute_cmd(se_cmd);
738 static int tcm_loop_write_pending_status(struct se_cmd *se_cmd)
743 static int tcm_loop_queue_data_in(struct se_cmd *se_cmd)
745 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
746 struct tcm_loop_cmd, tl_se_cmd);
747 struct scsi_cmnd *sc = tl_cmd->sc;
749 pr_debug("tcm_loop_queue_data_in() called for scsi_cmnd: %p"
750 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
752 sc->result = SAM_STAT_GOOD;
753 set_host_byte(sc, DID_OK);
754 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) ||
755 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT))
756 scsi_set_resid(sc, se_cmd->residual_count);
761 static int tcm_loop_queue_status(struct se_cmd *se_cmd)
763 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
764 struct tcm_loop_cmd, tl_se_cmd);
765 struct scsi_cmnd *sc = tl_cmd->sc;
767 pr_debug("tcm_loop_queue_status() called for scsi_cmnd: %p"
768 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
770 if (se_cmd->sense_buffer &&
771 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
772 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) {
774 memcpy(sc->sense_buffer, se_cmd->sense_buffer,
775 SCSI_SENSE_BUFFERSIZE);
776 sc->result = SAM_STAT_CHECK_CONDITION;
777 set_driver_byte(sc, DRIVER_SENSE);
779 sc->result = se_cmd->scsi_status;
781 set_host_byte(sc, DID_OK);
782 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) ||
783 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT))
784 scsi_set_resid(sc, se_cmd->residual_count);
789 static int tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd)
791 struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
792 struct tcm_loop_tmr *tl_tmr = se_tmr->fabric_tmr_ptr;
794 * The SCSI EH thread will be sleeping on se_tmr->tl_tmr_wait, go ahead
795 * and wake up the wait_queue_head_t in tcm_loop_device_reset()
797 atomic_set(&tl_tmr->tmr_complete, 1);
798 wake_up(&tl_tmr->tl_tmr_wait);
802 static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba)
804 switch (tl_hba->tl_proto_id) {
805 case SCSI_PROTOCOL_SAS:
807 case SCSI_PROTOCOL_FCP:
809 case SCSI_PROTOCOL_ISCSI:
818 /* Start items for tcm_loop_port_cit */
820 static int tcm_loop_port_link(
821 struct se_portal_group *se_tpg,
824 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
825 struct tcm_loop_tpg, tl_se_tpg);
826 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
828 atomic_inc(&tl_tpg->tl_tpg_port_count);
829 smp_mb__after_atomic_inc();
831 * Add Linux/SCSI struct scsi_device by HCTL
833 scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun);
835 pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n");
839 static void tcm_loop_port_unlink(
840 struct se_portal_group *se_tpg,
841 struct se_lun *se_lun)
843 struct scsi_device *sd;
844 struct tcm_loop_hba *tl_hba;
845 struct tcm_loop_tpg *tl_tpg;
847 tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
848 tl_hba = tl_tpg->tl_hba;
850 sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt,
851 se_lun->unpacked_lun);
853 pr_err("Unable to locate struct scsi_device for %d:%d:"
854 "%d\n", 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun);
858 * Remove Linux/SCSI struct scsi_device by HCTL
860 scsi_remove_device(sd);
863 atomic_dec(&tl_tpg->tl_tpg_port_count);
864 smp_mb__after_atomic_dec();
866 pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n");
869 /* End items for tcm_loop_port_cit */
871 /* Start items for tcm_loop_nexus_cit */
873 static int tcm_loop_make_nexus(
874 struct tcm_loop_tpg *tl_tpg,
877 struct se_portal_group *se_tpg;
878 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
879 struct tcm_loop_nexus *tl_nexus;
882 if (tl_tpg->tl_hba->tl_nexus) {
883 pr_debug("tl_tpg->tl_hba->tl_nexus already exists\n");
886 se_tpg = &tl_tpg->tl_se_tpg;
888 tl_nexus = kzalloc(sizeof(struct tcm_loop_nexus), GFP_KERNEL);
890 pr_err("Unable to allocate struct tcm_loop_nexus\n");
894 * Initialize the struct se_session pointer
896 tl_nexus->se_sess = transport_init_session();
897 if (IS_ERR(tl_nexus->se_sess)) {
898 ret = PTR_ERR(tl_nexus->se_sess);
902 * Since we are running in 'demo mode' this call with generate a
903 * struct se_node_acl for the tcm_loop struct se_portal_group with the SCSI
904 * Initiator port name of the passed configfs group 'name'.
906 tl_nexus->se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
907 se_tpg, (unsigned char *)name);
908 if (!tl_nexus->se_sess->se_node_acl) {
909 transport_free_session(tl_nexus->se_sess);
913 * Now, register the SAS I_T Nexus as active with the call to
914 * transport_register_session()
916 __transport_register_session(se_tpg, tl_nexus->se_sess->se_node_acl,
917 tl_nexus->se_sess, tl_nexus);
918 tl_tpg->tl_hba->tl_nexus = tl_nexus;
919 pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated"
920 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
929 static int tcm_loop_drop_nexus(
930 struct tcm_loop_tpg *tpg)
932 struct se_session *se_sess;
933 struct tcm_loop_nexus *tl_nexus;
934 struct tcm_loop_hba *tl_hba = tpg->tl_hba;
936 tl_nexus = tpg->tl_hba->tl_nexus;
940 se_sess = tl_nexus->se_sess;
944 if (atomic_read(&tpg->tl_tpg_port_count)) {
945 pr_err("Unable to remove TCM_Loop I_T Nexus with"
946 " active TPG port count: %d\n",
947 atomic_read(&tpg->tl_tpg_port_count));
951 pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated"
952 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
953 tl_nexus->se_sess->se_node_acl->initiatorname);
955 * Release the SCSI I_T Nexus to the emulated SAS Target Port
957 transport_deregister_session(tl_nexus->se_sess);
958 tpg->tl_hba->tl_nexus = NULL;
963 /* End items for tcm_loop_nexus_cit */
965 static ssize_t tcm_loop_tpg_show_nexus(
966 struct se_portal_group *se_tpg,
969 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
970 struct tcm_loop_tpg, tl_se_tpg);
971 struct tcm_loop_nexus *tl_nexus;
974 tl_nexus = tl_tpg->tl_hba->tl_nexus;
978 ret = snprintf(page, PAGE_SIZE, "%s\n",
979 tl_nexus->se_sess->se_node_acl->initiatorname);
984 static ssize_t tcm_loop_tpg_store_nexus(
985 struct se_portal_group *se_tpg,
989 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
990 struct tcm_loop_tpg, tl_se_tpg);
991 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
992 unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr;
995 * Shutdown the active I_T nexus if 'NULL' is passed..
997 if (!strncmp(page, "NULL", 4)) {
998 ret = tcm_loop_drop_nexus(tl_tpg);
999 return (!ret) ? count : ret;
1002 * Otherwise make sure the passed virtual Initiator port WWN matches
1003 * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call
1004 * tcm_loop_make_nexus()
1006 if (strlen(page) >= TL_WWN_ADDR_LEN) {
1007 pr_err("Emulated NAA Sas Address: %s, exceeds"
1008 " max: %d\n", page, TL_WWN_ADDR_LEN);
1011 snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page);
1013 ptr = strstr(i_port, "naa.");
1015 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) {
1016 pr_err("Passed SAS Initiator Port %s does not"
1017 " match target port protoid: %s\n", i_port,
1018 tcm_loop_dump_proto_id(tl_hba));
1021 port_ptr = &i_port[0];
1024 ptr = strstr(i_port, "fc.");
1026 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) {
1027 pr_err("Passed FCP Initiator Port %s does not"
1028 " match target port protoid: %s\n", i_port,
1029 tcm_loop_dump_proto_id(tl_hba));
1032 port_ptr = &i_port[3]; /* Skip over "fc." */
1035 ptr = strstr(i_port, "iqn.");
1037 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) {
1038 pr_err("Passed iSCSI Initiator Port %s does not"
1039 " match target port protoid: %s\n", i_port,
1040 tcm_loop_dump_proto_id(tl_hba));
1043 port_ptr = &i_port[0];
1046 pr_err("Unable to locate prefix for emulated Initiator Port:"
1050 * Clear any trailing newline for the NAA WWN
1053 if (i_port[strlen(i_port)-1] == '\n')
1054 i_port[strlen(i_port)-1] = '\0';
1056 ret = tcm_loop_make_nexus(tl_tpg, port_ptr);
1063 TF_TPG_BASE_ATTR(tcm_loop, nexus, S_IRUGO | S_IWUSR);
1065 static struct configfs_attribute *tcm_loop_tpg_attrs[] = {
1066 &tcm_loop_tpg_nexus.attr,
1070 /* Start items for tcm_loop_naa_cit */
1072 struct se_portal_group *tcm_loop_make_naa_tpg(
1074 struct config_group *group,
1077 struct tcm_loop_hba *tl_hba = container_of(wwn,
1078 struct tcm_loop_hba, tl_hba_wwn);
1079 struct tcm_loop_tpg *tl_tpg;
1080 char *tpgt_str, *end_ptr;
1082 unsigned short int tpgt;
1084 tpgt_str = strstr(name, "tpgt_");
1086 pr_err("Unable to locate \"tpgt_#\" directory"
1088 return ERR_PTR(-EINVAL);
1090 tpgt_str += 5; /* Skip ahead of "tpgt_" */
1091 tpgt = (unsigned short int) simple_strtoul(tpgt_str, &end_ptr, 0);
1093 if (tpgt >= TL_TPGS_PER_HBA) {
1094 pr_err("Passed tpgt: %hu exceeds TL_TPGS_PER_HBA:"
1095 " %u\n", tpgt, TL_TPGS_PER_HBA);
1096 return ERR_PTR(-EINVAL);
1098 tl_tpg = &tl_hba->tl_hba_tpgs[tpgt];
1099 tl_tpg->tl_hba = tl_hba;
1100 tl_tpg->tl_tpgt = tpgt;
1102 * Register the tl_tpg as a emulated SAS TCM Target Endpoint
1104 ret = core_tpg_register(&tcm_loop_fabric_configfs->tf_ops,
1105 wwn, &tl_tpg->tl_se_tpg, tl_tpg,
1106 TRANSPORT_TPG_TYPE_NORMAL);
1108 return ERR_PTR(-ENOMEM);
1110 pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s"
1111 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1112 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1114 return &tl_tpg->tl_se_tpg;
1117 void tcm_loop_drop_naa_tpg(
1118 struct se_portal_group *se_tpg)
1120 struct se_wwn *wwn = se_tpg->se_tpg_wwn;
1121 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1122 struct tcm_loop_tpg, tl_se_tpg);
1123 struct tcm_loop_hba *tl_hba;
1124 unsigned short tpgt;
1126 tl_hba = tl_tpg->tl_hba;
1127 tpgt = tl_tpg->tl_tpgt;
1129 * Release the I_T Nexus for the Virtual SAS link if present
1131 tcm_loop_drop_nexus(tl_tpg);
1133 * Deregister the tl_tpg as a emulated SAS TCM Target Endpoint
1135 core_tpg_deregister(se_tpg);
1137 tl_tpg->tl_hba = NULL;
1138 tl_tpg->tl_tpgt = 0;
1140 pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s"
1141 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1142 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1145 /* End items for tcm_loop_naa_cit */
1147 /* Start items for tcm_loop_cit */
1149 struct se_wwn *tcm_loop_make_scsi_hba(
1150 struct target_fabric_configfs *tf,
1151 struct config_group *group,
1154 struct tcm_loop_hba *tl_hba;
1155 struct Scsi_Host *sh;
1159 tl_hba = kzalloc(sizeof(struct tcm_loop_hba), GFP_KERNEL);
1161 pr_err("Unable to allocate struct tcm_loop_hba\n");
1162 return ERR_PTR(-ENOMEM);
1165 * Determine the emulated Protocol Identifier and Target Port Name
1166 * based on the incoming configfs directory name.
1168 ptr = strstr(name, "naa.");
1170 tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS;
1173 ptr = strstr(name, "fc.");
1175 tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP;
1176 off = 3; /* Skip over "fc." */
1179 ptr = strstr(name, "iqn.");
1181 pr_err("Unable to locate prefix for emulated Target "
1182 "Port: %s\n", name);
1186 tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI;
1189 if (strlen(name) >= TL_WWN_ADDR_LEN) {
1190 pr_err("Emulated NAA %s Address: %s, exceeds"
1191 " max: %d\n", name, tcm_loop_dump_proto_id(tl_hba),
1196 snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]);
1199 * Call device_register(tl_hba->dev) to register the emulated
1200 * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after
1201 * device_register() callbacks in tcm_loop_driver_probe()
1203 ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt);
1208 tcm_loop_hba_no_cnt++;
1209 pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target"
1210 " %s Address: %s at Linux/SCSI Host ID: %d\n",
1211 tcm_loop_dump_proto_id(tl_hba), name, sh->host_no);
1213 return &tl_hba->tl_hba_wwn;
1216 return ERR_PTR(ret);
1219 void tcm_loop_drop_scsi_hba(
1222 struct tcm_loop_hba *tl_hba = container_of(wwn,
1223 struct tcm_loop_hba, tl_hba_wwn);
1225 pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target"
1226 " SAS Address: %s at Linux/SCSI Host ID: %d\n",
1227 tl_hba->tl_wwn_address, tl_hba->sh->host_no);
1229 * Call device_unregister() on the original tl_hba->dev.
1230 * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will
1233 device_unregister(&tl_hba->dev);
1236 /* Start items for tcm_loop_cit */
1237 static ssize_t tcm_loop_wwn_show_attr_version(
1238 struct target_fabric_configfs *tf,
1241 return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION);
1244 TF_WWN_ATTR_RO(tcm_loop, version);
1246 static struct configfs_attribute *tcm_loop_wwn_attrs[] = {
1247 &tcm_loop_wwn_version.attr,
1251 /* End items for tcm_loop_cit */
1253 static int tcm_loop_register_configfs(void)
1255 struct target_fabric_configfs *fabric;
1258 * Set the TCM Loop HBA counter to zero
1260 tcm_loop_hba_no_cnt = 0;
1262 * Register the top level struct config_item_type with TCM core
1264 fabric = target_fabric_configfs_init(THIS_MODULE, "loopback");
1265 if (IS_ERR(fabric)) {
1266 pr_err("tcm_loop_register_configfs() failed!\n");
1267 return PTR_ERR(fabric);
1270 * Setup the fabric API of function pointers used by target_core_mod
1272 fabric->tf_ops.get_fabric_name = &tcm_loop_get_fabric_name;
1273 fabric->tf_ops.get_fabric_proto_ident = &tcm_loop_get_fabric_proto_ident;
1274 fabric->tf_ops.tpg_get_wwn = &tcm_loop_get_endpoint_wwn;
1275 fabric->tf_ops.tpg_get_tag = &tcm_loop_get_tag;
1276 fabric->tf_ops.tpg_get_default_depth = &tcm_loop_get_default_depth;
1277 fabric->tf_ops.tpg_get_pr_transport_id = &tcm_loop_get_pr_transport_id;
1278 fabric->tf_ops.tpg_get_pr_transport_id_len =
1279 &tcm_loop_get_pr_transport_id_len;
1280 fabric->tf_ops.tpg_parse_pr_out_transport_id =
1281 &tcm_loop_parse_pr_out_transport_id;
1282 fabric->tf_ops.tpg_check_demo_mode = &tcm_loop_check_demo_mode;
1283 fabric->tf_ops.tpg_check_demo_mode_cache =
1284 &tcm_loop_check_demo_mode_cache;
1285 fabric->tf_ops.tpg_check_demo_mode_write_protect =
1286 &tcm_loop_check_demo_mode_write_protect;
1287 fabric->tf_ops.tpg_check_prod_mode_write_protect =
1288 &tcm_loop_check_prod_mode_write_protect;
1290 * The TCM loopback fabric module runs in demo-mode to a local
1291 * virtual SCSI device, so fabric dependent initator ACLs are
1294 fabric->tf_ops.tpg_alloc_fabric_acl = &tcm_loop_tpg_alloc_fabric_acl;
1295 fabric->tf_ops.tpg_release_fabric_acl =
1296 &tcm_loop_tpg_release_fabric_acl;
1297 fabric->tf_ops.tpg_get_inst_index = &tcm_loop_get_inst_index;
1299 * Used for setting up remaining TCM resources in process context
1301 fabric->tf_ops.check_stop_free = &tcm_loop_check_stop_free;
1302 fabric->tf_ops.release_cmd = &tcm_loop_release_cmd;
1303 fabric->tf_ops.shutdown_session = &tcm_loop_shutdown_session;
1304 fabric->tf_ops.close_session = &tcm_loop_close_session;
1305 fabric->tf_ops.sess_get_index = &tcm_loop_sess_get_index;
1306 fabric->tf_ops.sess_get_initiator_sid = NULL;
1307 fabric->tf_ops.write_pending = &tcm_loop_write_pending;
1308 fabric->tf_ops.write_pending_status = &tcm_loop_write_pending_status;
1310 * Not used for TCM loopback
1312 fabric->tf_ops.set_default_node_attributes =
1313 &tcm_loop_set_default_node_attributes;
1314 fabric->tf_ops.get_task_tag = &tcm_loop_get_task_tag;
1315 fabric->tf_ops.get_cmd_state = &tcm_loop_get_cmd_state;
1316 fabric->tf_ops.queue_data_in = &tcm_loop_queue_data_in;
1317 fabric->tf_ops.queue_status = &tcm_loop_queue_status;
1318 fabric->tf_ops.queue_tm_rsp = &tcm_loop_queue_tm_rsp;
1321 * Setup function pointers for generic logic in target_core_fabric_configfs.c
1323 fabric->tf_ops.fabric_make_wwn = &tcm_loop_make_scsi_hba;
1324 fabric->tf_ops.fabric_drop_wwn = &tcm_loop_drop_scsi_hba;
1325 fabric->tf_ops.fabric_make_tpg = &tcm_loop_make_naa_tpg;
1326 fabric->tf_ops.fabric_drop_tpg = &tcm_loop_drop_naa_tpg;
1328 * fabric_post_link() and fabric_pre_unlink() are used for
1329 * registration and release of TCM Loop Virtual SCSI LUNs.
1331 fabric->tf_ops.fabric_post_link = &tcm_loop_port_link;
1332 fabric->tf_ops.fabric_pre_unlink = &tcm_loop_port_unlink;
1333 fabric->tf_ops.fabric_make_np = NULL;
1334 fabric->tf_ops.fabric_drop_np = NULL;
1336 * Setup default attribute lists for various fabric->tf_cit_tmpl
1338 TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = tcm_loop_wwn_attrs;
1339 TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = tcm_loop_tpg_attrs;
1340 TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
1341 TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
1342 TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
1344 * Once fabric->tf_ops has been setup, now register the fabric for
1347 ret = target_fabric_configfs_register(fabric);
1349 pr_err("target_fabric_configfs_register() for"
1350 " TCM_Loop failed!\n");
1351 target_fabric_configfs_free(fabric);
1355 * Setup our local pointer to *fabric.
1357 tcm_loop_fabric_configfs = fabric;
1358 pr_debug("TCM_LOOP[0] - Set fabric ->"
1359 " tcm_loop_fabric_configfs\n");
1363 static void tcm_loop_deregister_configfs(void)
1365 if (!tcm_loop_fabric_configfs)
1368 target_fabric_configfs_deregister(tcm_loop_fabric_configfs);
1369 tcm_loop_fabric_configfs = NULL;
1370 pr_debug("TCM_LOOP[0] - Cleared"
1371 " tcm_loop_fabric_configfs\n");
1374 static int __init tcm_loop_fabric_init(void)
1378 tcm_loop_workqueue = alloc_workqueue("tcm_loop", 0, 0);
1379 if (!tcm_loop_workqueue)
1382 tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache",
1383 sizeof(struct tcm_loop_cmd),
1384 __alignof__(struct tcm_loop_cmd),
1386 if (!tcm_loop_cmd_cache) {
1387 pr_debug("kmem_cache_create() for"
1388 " tcm_loop_cmd_cache failed\n");
1389 goto out_destroy_workqueue;
1392 ret = tcm_loop_alloc_core_bus();
1394 goto out_destroy_cache;
1396 ret = tcm_loop_register_configfs();
1398 goto out_release_core_bus;
1402 out_release_core_bus:
1403 tcm_loop_release_core_bus();
1405 kmem_cache_destroy(tcm_loop_cmd_cache);
1406 out_destroy_workqueue:
1407 destroy_workqueue(tcm_loop_workqueue);
1412 static void __exit tcm_loop_fabric_exit(void)
1414 tcm_loop_deregister_configfs();
1415 tcm_loop_release_core_bus();
1416 kmem_cache_destroy(tcm_loop_cmd_cache);
1417 destroy_workqueue(tcm_loop_workqueue);
1420 MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module");
1421 MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>");
1422 MODULE_LICENSE("GPL");
1423 module_init(tcm_loop_fabric_init);
1424 module_exit(tcm_loop_fabric_exit);