1 /*******************************************************************************
3 * This file contains the Linux/SCSI LLD virtual SCSI initiator driver
4 * for emulated SAS initiator ports
6 * © Copyright 2011-2013 Datera, Inc.
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>
40 #define to_tcm_loop_hba(hba) container_of(hba, struct tcm_loop_hba, dev)
42 static struct workqueue_struct *tcm_loop_workqueue;
43 static struct kmem_cache *tcm_loop_cmd_cache;
45 static int tcm_loop_hba_no_cnt;
47 static int tcm_loop_queue_status(struct se_cmd *se_cmd);
50 * Called from struct target_core_fabric_ops->check_stop_free()
52 static int tcm_loop_check_stop_free(struct se_cmd *se_cmd)
54 return transport_generic_free_cmd(se_cmd, 0);
57 static void tcm_loop_release_cmd(struct se_cmd *se_cmd)
59 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
60 struct tcm_loop_cmd, tl_se_cmd);
62 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
65 static int tcm_loop_show_info(struct seq_file *m, struct Scsi_Host *host)
67 seq_puts(m, "tcm_loop_proc_info()\n");
71 static int tcm_loop_driver_probe(struct device *);
72 static int tcm_loop_driver_remove(struct device *);
74 static int pseudo_lld_bus_match(struct device *dev,
75 struct device_driver *dev_driver)
80 static struct bus_type tcm_loop_lld_bus = {
81 .name = "tcm_loop_bus",
82 .match = pseudo_lld_bus_match,
83 .probe = tcm_loop_driver_probe,
84 .remove = tcm_loop_driver_remove,
87 static struct device_driver tcm_loop_driverfs = {
89 .bus = &tcm_loop_lld_bus,
92 * Used with root_device_register() in tcm_loop_alloc_core_bus() below
94 static struct device *tcm_loop_primary;
96 static void tcm_loop_submission_work(struct work_struct *work)
98 struct tcm_loop_cmd *tl_cmd =
99 container_of(work, struct tcm_loop_cmd, work);
100 struct se_cmd *se_cmd = &tl_cmd->tl_se_cmd;
101 struct scsi_cmnd *sc = tl_cmd->sc;
102 struct tcm_loop_nexus *tl_nexus;
103 struct tcm_loop_hba *tl_hba;
104 struct tcm_loop_tpg *tl_tpg;
105 struct scatterlist *sgl_bidi = NULL;
106 u32 sgl_bidi_count = 0, transfer_length;
109 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
110 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
113 * Ensure that this tl_tpg reference from the incoming sc->device->id
114 * has already been configured via tcm_loop_make_naa_tpg().
116 if (!tl_tpg->tl_hba) {
117 set_host_byte(sc, DID_NO_CONNECT);
120 if (tl_tpg->tl_transport_status == TCM_TRANSPORT_OFFLINE) {
121 set_host_byte(sc, DID_TRANSPORT_DISRUPTED);
124 tl_nexus = tl_tpg->tl_nexus;
126 scmd_printk(KERN_ERR, sc,
127 "TCM_Loop I_T Nexus does not exist\n");
128 set_host_byte(sc, DID_ERROR);
132 transfer_length = scsi_transfer_length(sc);
133 if (!scsi_prot_sg_count(sc) &&
134 scsi_get_prot_op(sc) != SCSI_PROT_NORMAL) {
135 se_cmd->prot_pto = true;
137 * loopback transport doesn't support
138 * WRITE_GENERATE, READ_STRIP protection
139 * information operations, go ahead unprotected.
141 transfer_length = scsi_bufflen(sc);
144 se_cmd->tag = tl_cmd->sc_cmd_tag;
145 rc = target_submit_cmd_map_sgls(se_cmd, tl_nexus->se_sess, sc->cmnd,
146 &tl_cmd->tl_sense_buf[0], tl_cmd->sc->device->lun,
147 transfer_length, TCM_SIMPLE_TAG,
148 sc->sc_data_direction, 0,
149 scsi_sglist(sc), scsi_sg_count(sc),
150 sgl_bidi, sgl_bidi_count,
151 scsi_prot_sglist(sc), scsi_prot_sg_count(sc));
153 set_host_byte(sc, DID_NO_CONNECT);
159 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
164 * ->queuecommand can be and usually is called from interrupt context, so
165 * defer the actual submission to a workqueue.
167 static int tcm_loop_queuecommand(struct Scsi_Host *sh, struct scsi_cmnd *sc)
169 struct tcm_loop_cmd *tl_cmd;
171 pr_debug("%s() %d:%d:%d:%llu got CDB: 0x%02x scsi_buf_len: %u\n",
172 __func__, sc->device->host->host_no, sc->device->id,
173 sc->device->channel, sc->device->lun, sc->cmnd[0],
176 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC);
178 set_host_byte(sc, DID_ERROR);
184 tl_cmd->sc_cmd_tag = sc->request->tag;
185 INIT_WORK(&tl_cmd->work, tcm_loop_submission_work);
186 queue_work(tcm_loop_workqueue, &tl_cmd->work);
191 * Called from SCSI EH process context to issue a LUN_RESET TMR
192 * to struct scsi_device
194 static int tcm_loop_issue_tmr(struct tcm_loop_tpg *tl_tpg,
195 u64 lun, int task, enum tcm_tmreq_table tmr)
197 struct se_cmd *se_cmd;
198 struct se_session *se_sess;
199 struct tcm_loop_nexus *tl_nexus;
200 struct tcm_loop_cmd *tl_cmd;
201 int ret = TMR_FUNCTION_FAILED, rc;
204 * Locate the tl_nexus and se_sess pointers
206 tl_nexus = tl_tpg->tl_nexus;
208 pr_err("Unable to perform device reset without active I_T Nexus\n");
212 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL);
216 init_completion(&tl_cmd->tmr_done);
218 se_cmd = &tl_cmd->tl_se_cmd;
219 se_sess = tl_tpg->tl_nexus->se_sess;
221 rc = target_submit_tmr(se_cmd, se_sess, tl_cmd->tl_sense_buf, lun,
222 NULL, tmr, GFP_KERNEL, task,
223 TARGET_SCF_ACK_KREF);
226 wait_for_completion(&tl_cmd->tmr_done);
227 ret = se_cmd->se_tmr_req->response;
228 target_put_sess_cmd(se_cmd);
234 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
238 static int tcm_loop_abort_task(struct scsi_cmnd *sc)
240 struct tcm_loop_hba *tl_hba;
241 struct tcm_loop_tpg *tl_tpg;
245 * Locate the tcm_loop_hba_t pointer
247 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
248 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
249 ret = tcm_loop_issue_tmr(tl_tpg, sc->device->lun,
250 sc->request->tag, TMR_ABORT_TASK);
251 return (ret == TMR_FUNCTION_COMPLETE) ? SUCCESS : FAILED;
255 * Called from SCSI EH process context to issue a LUN_RESET TMR
256 * to struct scsi_device
258 static int tcm_loop_device_reset(struct scsi_cmnd *sc)
260 struct tcm_loop_hba *tl_hba;
261 struct tcm_loop_tpg *tl_tpg;
265 * Locate the tcm_loop_hba_t pointer
267 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
268 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
270 ret = tcm_loop_issue_tmr(tl_tpg, sc->device->lun,
272 return (ret == TMR_FUNCTION_COMPLETE) ? SUCCESS : FAILED;
275 static int tcm_loop_target_reset(struct scsi_cmnd *sc)
277 struct tcm_loop_hba *tl_hba;
278 struct tcm_loop_tpg *tl_tpg;
281 * Locate the tcm_loop_hba_t pointer
283 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
285 pr_err("Unable to perform device reset without active I_T Nexus\n");
289 * Locate the tl_tpg pointer from TargetID in sc->device->id
291 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
293 tl_tpg->tl_transport_status = TCM_TRANSPORT_ONLINE;
299 static struct scsi_host_template tcm_loop_driver_template = {
300 .show_info = tcm_loop_show_info,
301 .proc_name = "tcm_loopback",
302 .name = "TCM_Loopback",
303 .queuecommand = tcm_loop_queuecommand,
304 .change_queue_depth = scsi_change_queue_depth,
305 .eh_abort_handler = tcm_loop_abort_task,
306 .eh_device_reset_handler = tcm_loop_device_reset,
307 .eh_target_reset_handler = tcm_loop_target_reset,
312 .max_sectors = 0xFFFF,
313 .dma_boundary = PAGE_SIZE - 1,
314 .module = THIS_MODULE,
315 .track_queue_depth = 1,
318 static int tcm_loop_driver_probe(struct device *dev)
320 struct tcm_loop_hba *tl_hba;
321 struct Scsi_Host *sh;
322 int error, host_prot;
324 tl_hba = to_tcm_loop_hba(dev);
326 sh = scsi_host_alloc(&tcm_loop_driver_template,
327 sizeof(struct tcm_loop_hba));
329 pr_err("Unable to allocate struct scsi_host\n");
335 * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata
337 *((struct tcm_loop_hba **)sh->hostdata) = tl_hba;
339 * Setup single ID, Channel and LUN for now..
344 sh->max_cmd_len = SCSI_MAX_VARLEN_CDB_SIZE;
346 host_prot = SHOST_DIF_TYPE1_PROTECTION | SHOST_DIF_TYPE2_PROTECTION |
347 SHOST_DIF_TYPE3_PROTECTION | SHOST_DIX_TYPE1_PROTECTION |
348 SHOST_DIX_TYPE2_PROTECTION | SHOST_DIX_TYPE3_PROTECTION;
350 scsi_host_set_prot(sh, host_prot);
351 scsi_host_set_guard(sh, SHOST_DIX_GUARD_CRC);
353 error = scsi_add_host(sh, &tl_hba->dev);
355 pr_err("%s: scsi_add_host failed\n", __func__);
362 static int tcm_loop_driver_remove(struct device *dev)
364 struct tcm_loop_hba *tl_hba;
365 struct Scsi_Host *sh;
367 tl_hba = to_tcm_loop_hba(dev);
370 scsi_remove_host(sh);
375 static void tcm_loop_release_adapter(struct device *dev)
377 struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev);
383 * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c
385 static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id)
389 tl_hba->dev.bus = &tcm_loop_lld_bus;
390 tl_hba->dev.parent = tcm_loop_primary;
391 tl_hba->dev.release = &tcm_loop_release_adapter;
392 dev_set_name(&tl_hba->dev, "tcm_loop_adapter_%d", tcm_loop_host_id);
394 ret = device_register(&tl_hba->dev);
396 pr_err("device_register() failed for tl_hba->dev: %d\n", ret);
397 put_device(&tl_hba->dev);
405 * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated
408 static int tcm_loop_alloc_core_bus(void)
412 tcm_loop_primary = root_device_register("tcm_loop_0");
413 if (IS_ERR(tcm_loop_primary)) {
414 pr_err("Unable to allocate tcm_loop_primary\n");
415 return PTR_ERR(tcm_loop_primary);
418 ret = bus_register(&tcm_loop_lld_bus);
420 pr_err("bus_register() failed for tcm_loop_lld_bus\n");
424 ret = driver_register(&tcm_loop_driverfs);
426 pr_err("driver_register() failed for tcm_loop_driverfs\n");
430 pr_debug("Initialized TCM Loop Core Bus\n");
434 bus_unregister(&tcm_loop_lld_bus);
436 root_device_unregister(tcm_loop_primary);
440 static void tcm_loop_release_core_bus(void)
442 driver_unregister(&tcm_loop_driverfs);
443 bus_unregister(&tcm_loop_lld_bus);
444 root_device_unregister(tcm_loop_primary);
446 pr_debug("Releasing TCM Loop Core BUS\n");
449 static inline struct tcm_loop_tpg *tl_tpg(struct se_portal_group *se_tpg)
451 return container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
454 static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg)
457 * Return the passed NAA identifier for the Target Port
459 return &tl_tpg(se_tpg)->tl_hba->tl_wwn_address[0];
462 static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg)
465 * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83
466 * to represent the SCSI Target Port.
468 return tl_tpg(se_tpg)->tl_tpgt;
472 * Returning (1) here allows for target_core_mod struct se_node_acl to be generated
473 * based upon the incoming fabric dependent SCSI Initiator Port
475 static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg)
480 static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg)
486 * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for
487 * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest
489 static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg)
495 * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will
496 * never be called for TCM_Loop by target_core_fabric_configfs.c code.
497 * It has been added here as a nop for target_fabric_tf_ops_check()
499 static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg)
504 static int tcm_loop_check_prot_fabric_only(struct se_portal_group *se_tpg)
506 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg,
508 return tl_tpg->tl_fabric_prot_type;
511 static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg)
516 static u32 tcm_loop_sess_get_index(struct se_session *se_sess)
521 static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl)
526 static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd)
528 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
529 struct tcm_loop_cmd, tl_se_cmd);
531 return tl_cmd->sc_cmd_state;
534 static int tcm_loop_write_pending(struct se_cmd *se_cmd)
537 * Since Linux/SCSI has already sent down a struct scsi_cmnd
538 * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array
539 * memory, and memory has already been mapped to struct se_cmd->t_mem_list
540 * format with transport_generic_map_mem_to_cmd().
542 * We now tell TCM to add this WRITE CDB directly into the TCM storage
543 * object execution queue.
545 target_execute_cmd(se_cmd);
549 static int tcm_loop_queue_data_or_status(const char *func,
550 struct se_cmd *se_cmd, u8 scsi_status)
552 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
553 struct tcm_loop_cmd, tl_se_cmd);
554 struct scsi_cmnd *sc = tl_cmd->sc;
556 pr_debug("%s() called for scsi_cmnd: %p cdb: 0x%02x\n",
557 func, sc, sc->cmnd[0]);
559 if (se_cmd->sense_buffer &&
560 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
561 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) {
563 memcpy(sc->sense_buffer, se_cmd->sense_buffer,
564 SCSI_SENSE_BUFFERSIZE);
565 sc->result = SAM_STAT_CHECK_CONDITION;
566 set_driver_byte(sc, DRIVER_SENSE);
568 sc->result = scsi_status;
570 set_host_byte(sc, DID_OK);
571 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) ||
572 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT))
573 scsi_set_resid(sc, se_cmd->residual_count);
578 static int tcm_loop_queue_data_in(struct se_cmd *se_cmd)
580 return tcm_loop_queue_data_or_status(__func__, se_cmd, SAM_STAT_GOOD);
583 static int tcm_loop_queue_status(struct se_cmd *se_cmd)
585 return tcm_loop_queue_data_or_status(__func__,
586 se_cmd, se_cmd->scsi_status);
589 static void tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd)
591 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
592 struct tcm_loop_cmd, tl_se_cmd);
594 /* Wake up tcm_loop_issue_tmr(). */
595 complete(&tl_cmd->tmr_done);
598 static void tcm_loop_aborted_task(struct se_cmd *se_cmd)
603 static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba)
605 switch (tl_hba->tl_proto_id) {
606 case SCSI_PROTOCOL_SAS:
608 case SCSI_PROTOCOL_FCP:
610 case SCSI_PROTOCOL_ISCSI:
619 /* Start items for tcm_loop_port_cit */
621 static int tcm_loop_port_link(
622 struct se_portal_group *se_tpg,
625 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
626 struct tcm_loop_tpg, tl_se_tpg);
627 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
629 atomic_inc_mb(&tl_tpg->tl_tpg_port_count);
631 * Add Linux/SCSI struct scsi_device by HCTL
633 scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun);
635 pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n");
639 static void tcm_loop_port_unlink(
640 struct se_portal_group *se_tpg,
641 struct se_lun *se_lun)
643 struct scsi_device *sd;
644 struct tcm_loop_hba *tl_hba;
645 struct tcm_loop_tpg *tl_tpg;
647 tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
648 tl_hba = tl_tpg->tl_hba;
650 sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt,
651 se_lun->unpacked_lun);
653 pr_err("Unable to locate struct scsi_device for %d:%d:%llu\n",
654 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun);
658 * Remove Linux/SCSI struct scsi_device by HCTL
660 scsi_remove_device(sd);
663 atomic_dec_mb(&tl_tpg->tl_tpg_port_count);
665 pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n");
668 /* End items for tcm_loop_port_cit */
670 static ssize_t tcm_loop_tpg_attrib_fabric_prot_type_show(
671 struct config_item *item, char *page)
673 struct se_portal_group *se_tpg = attrib_to_tpg(item);
674 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg,
677 return sprintf(page, "%d\n", tl_tpg->tl_fabric_prot_type);
680 static ssize_t tcm_loop_tpg_attrib_fabric_prot_type_store(
681 struct config_item *item, const char *page, size_t count)
683 struct se_portal_group *se_tpg = attrib_to_tpg(item);
684 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg,
687 int ret = kstrtoul(page, 0, &val);
690 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
693 if (val != 0 && val != 1 && val != 3) {
694 pr_err("Invalid qla2xxx fabric_prot_type: %lu\n", val);
697 tl_tpg->tl_fabric_prot_type = val;
702 CONFIGFS_ATTR(tcm_loop_tpg_attrib_, fabric_prot_type);
704 static struct configfs_attribute *tcm_loop_tpg_attrib_attrs[] = {
705 &tcm_loop_tpg_attrib_attr_fabric_prot_type,
709 /* Start items for tcm_loop_nexus_cit */
711 static int tcm_loop_alloc_sess_cb(struct se_portal_group *se_tpg,
712 struct se_session *se_sess, void *p)
714 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
715 struct tcm_loop_tpg, tl_se_tpg);
717 tl_tpg->tl_nexus = p;
721 static int tcm_loop_make_nexus(
722 struct tcm_loop_tpg *tl_tpg,
725 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
726 struct tcm_loop_nexus *tl_nexus;
729 if (tl_tpg->tl_nexus) {
730 pr_debug("tl_tpg->tl_nexus already exists\n");
734 tl_nexus = kzalloc(sizeof(*tl_nexus), GFP_KERNEL);
738 tl_nexus->se_sess = target_setup_session(&tl_tpg->tl_se_tpg, 0, 0,
739 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS,
740 name, tl_nexus, tcm_loop_alloc_sess_cb);
741 if (IS_ERR(tl_nexus->se_sess)) {
742 ret = PTR_ERR(tl_nexus->se_sess);
747 pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated %s Initiator Port: %s\n",
748 tcm_loop_dump_proto_id(tl_hba), name);
752 static int tcm_loop_drop_nexus(
753 struct tcm_loop_tpg *tpg)
755 struct se_session *se_sess;
756 struct tcm_loop_nexus *tl_nexus;
758 tl_nexus = tpg->tl_nexus;
762 se_sess = tl_nexus->se_sess;
766 if (atomic_read(&tpg->tl_tpg_port_count)) {
767 pr_err("Unable to remove TCM_Loop I_T Nexus with active TPG port count: %d\n",
768 atomic_read(&tpg->tl_tpg_port_count));
772 pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated %s Initiator Port: %s\n",
773 tcm_loop_dump_proto_id(tpg->tl_hba),
774 tl_nexus->se_sess->se_node_acl->initiatorname);
776 * Release the SCSI I_T Nexus to the emulated Target Port
778 target_remove_session(se_sess);
779 tpg->tl_nexus = NULL;
784 /* End items for tcm_loop_nexus_cit */
786 static ssize_t tcm_loop_tpg_nexus_show(struct config_item *item, char *page)
788 struct se_portal_group *se_tpg = to_tpg(item);
789 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
790 struct tcm_loop_tpg, tl_se_tpg);
791 struct tcm_loop_nexus *tl_nexus;
794 tl_nexus = tl_tpg->tl_nexus;
798 ret = snprintf(page, PAGE_SIZE, "%s\n",
799 tl_nexus->se_sess->se_node_acl->initiatorname);
804 static ssize_t tcm_loop_tpg_nexus_store(struct config_item *item,
805 const char *page, size_t count)
807 struct se_portal_group *se_tpg = to_tpg(item);
808 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
809 struct tcm_loop_tpg, tl_se_tpg);
810 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
811 unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr;
814 * Shutdown the active I_T nexus if 'NULL' is passed..
816 if (!strncmp(page, "NULL", 4)) {
817 ret = tcm_loop_drop_nexus(tl_tpg);
818 return (!ret) ? count : ret;
821 * Otherwise make sure the passed virtual Initiator port WWN matches
822 * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call
823 * tcm_loop_make_nexus()
825 if (strlen(page) >= TL_WWN_ADDR_LEN) {
826 pr_err("Emulated NAA Sas Address: %s, exceeds max: %d\n",
827 page, TL_WWN_ADDR_LEN);
830 snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page);
832 ptr = strstr(i_port, "naa.");
834 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) {
835 pr_err("Passed SAS Initiator Port %s does not match target port protoid: %s\n",
836 i_port, tcm_loop_dump_proto_id(tl_hba));
839 port_ptr = &i_port[0];
842 ptr = strstr(i_port, "fc.");
844 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) {
845 pr_err("Passed FCP Initiator Port %s does not match target port protoid: %s\n",
846 i_port, tcm_loop_dump_proto_id(tl_hba));
849 port_ptr = &i_port[3]; /* Skip over "fc." */
852 ptr = strstr(i_port, "iqn.");
854 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) {
855 pr_err("Passed iSCSI Initiator Port %s does not match target port protoid: %s\n",
856 i_port, tcm_loop_dump_proto_id(tl_hba));
859 port_ptr = &i_port[0];
862 pr_err("Unable to locate prefix for emulated Initiator Port: %s\n",
866 * Clear any trailing newline for the NAA WWN
869 if (i_port[strlen(i_port)-1] == '\n')
870 i_port[strlen(i_port)-1] = '\0';
872 ret = tcm_loop_make_nexus(tl_tpg, port_ptr);
879 static ssize_t tcm_loop_tpg_transport_status_show(struct config_item *item,
882 struct se_portal_group *se_tpg = to_tpg(item);
883 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
884 struct tcm_loop_tpg, tl_se_tpg);
885 const char *status = NULL;
886 ssize_t ret = -EINVAL;
888 switch (tl_tpg->tl_transport_status) {
889 case TCM_TRANSPORT_ONLINE:
892 case TCM_TRANSPORT_OFFLINE:
900 ret = snprintf(page, PAGE_SIZE, "%s\n", status);
905 static ssize_t tcm_loop_tpg_transport_status_store(struct config_item *item,
906 const char *page, size_t count)
908 struct se_portal_group *se_tpg = to_tpg(item);
909 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
910 struct tcm_loop_tpg, tl_se_tpg);
912 if (!strncmp(page, "online", 6)) {
913 tl_tpg->tl_transport_status = TCM_TRANSPORT_ONLINE;
916 if (!strncmp(page, "offline", 7)) {
917 tl_tpg->tl_transport_status = TCM_TRANSPORT_OFFLINE;
918 if (tl_tpg->tl_nexus) {
919 struct se_session *tl_sess = tl_tpg->tl_nexus->se_sess;
921 core_allocate_nexus_loss_ua(tl_sess->se_node_acl);
928 static ssize_t tcm_loop_tpg_address_show(struct config_item *item,
931 struct se_portal_group *se_tpg = to_tpg(item);
932 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
933 struct tcm_loop_tpg, tl_se_tpg);
934 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
936 return snprintf(page, PAGE_SIZE, "%d:0:%d\n",
937 tl_hba->sh->host_no, tl_tpg->tl_tpgt);
940 CONFIGFS_ATTR(tcm_loop_tpg_, nexus);
941 CONFIGFS_ATTR(tcm_loop_tpg_, transport_status);
942 CONFIGFS_ATTR_RO(tcm_loop_tpg_, address);
944 static struct configfs_attribute *tcm_loop_tpg_attrs[] = {
945 &tcm_loop_tpg_attr_nexus,
946 &tcm_loop_tpg_attr_transport_status,
947 &tcm_loop_tpg_attr_address,
951 /* Start items for tcm_loop_naa_cit */
953 static struct se_portal_group *tcm_loop_make_naa_tpg(struct se_wwn *wwn,
956 struct tcm_loop_hba *tl_hba = container_of(wwn,
957 struct tcm_loop_hba, tl_hba_wwn);
958 struct tcm_loop_tpg *tl_tpg;
962 if (strstr(name, "tpgt_") != name) {
963 pr_err("Unable to locate \"tpgt_#\" directory group\n");
964 return ERR_PTR(-EINVAL);
966 if (kstrtoul(name+5, 10, &tpgt))
967 return ERR_PTR(-EINVAL);
969 if (tpgt >= TL_TPGS_PER_HBA) {
970 pr_err("Passed tpgt: %lu exceeds TL_TPGS_PER_HBA: %u\n",
971 tpgt, TL_TPGS_PER_HBA);
972 return ERR_PTR(-EINVAL);
974 tl_tpg = &tl_hba->tl_hba_tpgs[tpgt];
975 tl_tpg->tl_hba = tl_hba;
976 tl_tpg->tl_tpgt = tpgt;
978 * Register the tl_tpg as a emulated TCM Target Endpoint
980 ret = core_tpg_register(wwn, &tl_tpg->tl_se_tpg, tl_hba->tl_proto_id);
982 return ERR_PTR(-ENOMEM);
984 pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s Target Port %s,t,0x%04lx\n",
985 tcm_loop_dump_proto_id(tl_hba),
986 config_item_name(&wwn->wwn_group.cg_item), tpgt);
987 return &tl_tpg->tl_se_tpg;
990 static void tcm_loop_drop_naa_tpg(
991 struct se_portal_group *se_tpg)
993 struct se_wwn *wwn = se_tpg->se_tpg_wwn;
994 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
995 struct tcm_loop_tpg, tl_se_tpg);
996 struct tcm_loop_hba *tl_hba;
999 tl_hba = tl_tpg->tl_hba;
1000 tpgt = tl_tpg->tl_tpgt;
1002 * Release the I_T Nexus for the Virtual target link if present
1004 tcm_loop_drop_nexus(tl_tpg);
1006 * Deregister the tl_tpg as a emulated TCM Target Endpoint
1008 core_tpg_deregister(se_tpg);
1010 tl_tpg->tl_hba = NULL;
1011 tl_tpg->tl_tpgt = 0;
1013 pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s Target Port %s,t,0x%04x\n",
1014 tcm_loop_dump_proto_id(tl_hba),
1015 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1018 /* End items for tcm_loop_naa_cit */
1020 /* Start items for tcm_loop_cit */
1022 static struct se_wwn *tcm_loop_make_scsi_hba(
1023 struct target_fabric_configfs *tf,
1024 struct config_group *group,
1027 struct tcm_loop_hba *tl_hba;
1028 struct Scsi_Host *sh;
1032 tl_hba = kzalloc(sizeof(*tl_hba), GFP_KERNEL);
1034 return ERR_PTR(-ENOMEM);
1037 * Determine the emulated Protocol Identifier and Target Port Name
1038 * based on the incoming configfs directory name.
1040 ptr = strstr(name, "naa.");
1042 tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS;
1045 ptr = strstr(name, "fc.");
1047 tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP;
1048 off = 3; /* Skip over "fc." */
1051 ptr = strstr(name, "iqn.");
1053 pr_err("Unable to locate prefix for emulated Target Port: %s\n",
1058 tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI;
1061 if (strlen(name) >= TL_WWN_ADDR_LEN) {
1062 pr_err("Emulated NAA %s Address: %s, exceeds max: %d\n",
1063 name, tcm_loop_dump_proto_id(tl_hba), TL_WWN_ADDR_LEN);
1067 snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]);
1070 * Call device_register(tl_hba->dev) to register the emulated
1071 * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after
1072 * device_register() callbacks in tcm_loop_driver_probe()
1074 ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt);
1076 return ERR_PTR(ret);
1079 tcm_loop_hba_no_cnt++;
1080 pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target %s Address: %s at Linux/SCSI Host ID: %d\n",
1081 tcm_loop_dump_proto_id(tl_hba), name, sh->host_no);
1082 return &tl_hba->tl_hba_wwn;
1085 return ERR_PTR(ret);
1088 static void tcm_loop_drop_scsi_hba(
1091 struct tcm_loop_hba *tl_hba = container_of(wwn,
1092 struct tcm_loop_hba, tl_hba_wwn);
1094 pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target %s Address: %s at Linux/SCSI Host ID: %d\n",
1095 tcm_loop_dump_proto_id(tl_hba), tl_hba->tl_wwn_address,
1096 tl_hba->sh->host_no);
1098 * Call device_unregister() on the original tl_hba->dev.
1099 * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will
1102 device_unregister(&tl_hba->dev);
1105 /* Start items for tcm_loop_cit */
1106 static ssize_t tcm_loop_wwn_version_show(struct config_item *item, char *page)
1108 return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION);
1111 CONFIGFS_ATTR_RO(tcm_loop_wwn_, version);
1113 static struct configfs_attribute *tcm_loop_wwn_attrs[] = {
1114 &tcm_loop_wwn_attr_version,
1118 /* End items for tcm_loop_cit */
1120 static const struct target_core_fabric_ops loop_ops = {
1121 .module = THIS_MODULE,
1122 .fabric_name = "loopback",
1123 .tpg_get_wwn = tcm_loop_get_endpoint_wwn,
1124 .tpg_get_tag = tcm_loop_get_tag,
1125 .tpg_check_demo_mode = tcm_loop_check_demo_mode,
1126 .tpg_check_demo_mode_cache = tcm_loop_check_demo_mode_cache,
1127 .tpg_check_demo_mode_write_protect =
1128 tcm_loop_check_demo_mode_write_protect,
1129 .tpg_check_prod_mode_write_protect =
1130 tcm_loop_check_prod_mode_write_protect,
1131 .tpg_check_prot_fabric_only = tcm_loop_check_prot_fabric_only,
1132 .tpg_get_inst_index = tcm_loop_get_inst_index,
1133 .check_stop_free = tcm_loop_check_stop_free,
1134 .release_cmd = tcm_loop_release_cmd,
1135 .sess_get_index = tcm_loop_sess_get_index,
1136 .write_pending = tcm_loop_write_pending,
1137 .set_default_node_attributes = tcm_loop_set_default_node_attributes,
1138 .get_cmd_state = tcm_loop_get_cmd_state,
1139 .queue_data_in = tcm_loop_queue_data_in,
1140 .queue_status = tcm_loop_queue_status,
1141 .queue_tm_rsp = tcm_loop_queue_tm_rsp,
1142 .aborted_task = tcm_loop_aborted_task,
1143 .fabric_make_wwn = tcm_loop_make_scsi_hba,
1144 .fabric_drop_wwn = tcm_loop_drop_scsi_hba,
1145 .fabric_make_tpg = tcm_loop_make_naa_tpg,
1146 .fabric_drop_tpg = tcm_loop_drop_naa_tpg,
1147 .fabric_post_link = tcm_loop_port_link,
1148 .fabric_pre_unlink = tcm_loop_port_unlink,
1149 .tfc_wwn_attrs = tcm_loop_wwn_attrs,
1150 .tfc_tpg_base_attrs = tcm_loop_tpg_attrs,
1151 .tfc_tpg_attrib_attrs = tcm_loop_tpg_attrib_attrs,
1154 static int __init tcm_loop_fabric_init(void)
1158 tcm_loop_workqueue = alloc_workqueue("tcm_loop", 0, 0);
1159 if (!tcm_loop_workqueue)
1162 tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache",
1163 sizeof(struct tcm_loop_cmd),
1164 __alignof__(struct tcm_loop_cmd),
1166 if (!tcm_loop_cmd_cache) {
1167 pr_debug("kmem_cache_create() for tcm_loop_cmd_cache failed\n");
1168 goto out_destroy_workqueue;
1171 ret = tcm_loop_alloc_core_bus();
1173 goto out_destroy_cache;
1175 ret = target_register_template(&loop_ops);
1177 goto out_release_core_bus;
1181 out_release_core_bus:
1182 tcm_loop_release_core_bus();
1184 kmem_cache_destroy(tcm_loop_cmd_cache);
1185 out_destroy_workqueue:
1186 destroy_workqueue(tcm_loop_workqueue);
1191 static void __exit tcm_loop_fabric_exit(void)
1193 target_unregister_template(&loop_ops);
1194 tcm_loop_release_core_bus();
1195 kmem_cache_destroy(tcm_loop_cmd_cache);
1196 destroy_workqueue(tcm_loop_workqueue);
1199 MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module");
1200 MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>");
1201 MODULE_LICENSE("GPL");
1202 module_init(tcm_loop_fabric_init);
1203 module_exit(tcm_loop_fabric_exit);