tcm_loop: switch to using transport_handle_cdb_direct
[linux/fpc-iii.git] / drivers / target / loopback / tcm_loop.c
blob88fb3d1b0ad596b841cfc68b415ac300b346438f
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>
40 #include "tcm_loop.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)
65 return 0;
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);
71 return 1;
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_proc_info(struct Scsi_Host *host, char *buffer,
83 char **start, off_t offset,
84 int length, int inout)
86 return sprintf(buffer, "tcm_loop_proc_info()\n");
89 static int tcm_loop_driver_probe(struct device *);
90 static int tcm_loop_driver_remove(struct device *);
92 static int pseudo_lld_bus_match(struct device *dev,
93 struct device_driver *dev_driver)
95 return 1;
98 static struct bus_type tcm_loop_lld_bus = {
99 .name = "tcm_loop_bus",
100 .match = pseudo_lld_bus_match,
101 .probe = tcm_loop_driver_probe,
102 .remove = tcm_loop_driver_remove,
105 static struct device_driver tcm_loop_driverfs = {
106 .name = "tcm_loop",
107 .bus = &tcm_loop_lld_bus,
110 * Used with root_device_register() in tcm_loop_alloc_core_bus() below
112 struct device *tcm_loop_primary;
115 * Copied from drivers/scsi/libfc/fc_fcp.c:fc_change_queue_depth() and
116 * drivers/scsi/libiscsi.c:iscsi_change_queue_depth()
118 static int tcm_loop_change_queue_depth(
119 struct scsi_device *sdev,
120 int depth,
121 int reason)
123 switch (reason) {
124 case SCSI_QDEPTH_DEFAULT:
125 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
126 break;
127 case SCSI_QDEPTH_QFULL:
128 scsi_track_queue_full(sdev, depth);
129 break;
130 case SCSI_QDEPTH_RAMP_UP:
131 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
132 break;
133 default:
134 return -EOPNOTSUPP;
136 return sdev->queue_depth;
140 * Locate the SAM Task Attr from struct scsi_cmnd *
142 static int tcm_loop_sam_attr(struct scsi_cmnd *sc)
144 if (sc->device->tagged_supported) {
145 switch (sc->tag) {
146 case HEAD_OF_QUEUE_TAG:
147 return MSG_HEAD_TAG;
148 case ORDERED_QUEUE_TAG:
149 return MSG_ORDERED_TAG;
150 default:
151 break;
155 return MSG_SIMPLE_TAG;
158 static void tcm_loop_submission_work(struct work_struct *work)
160 struct tcm_loop_cmd *tl_cmd =
161 container_of(work, struct tcm_loop_cmd, work);
162 struct se_cmd *se_cmd = &tl_cmd->tl_se_cmd;
163 struct scsi_cmnd *sc = tl_cmd->sc;
164 struct tcm_loop_nexus *tl_nexus;
165 struct tcm_loop_hba *tl_hba;
166 struct tcm_loop_tpg *tl_tpg;
167 struct scatterlist *sgl_bidi = NULL;
168 u32 sgl_bidi_count = 0;
169 int ret;
171 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
172 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
175 * Ensure that this tl_tpg reference from the incoming sc->device->id
176 * has already been configured via tcm_loop_make_naa_tpg().
178 if (!tl_tpg->tl_hba) {
179 set_host_byte(sc, DID_NO_CONNECT);
180 goto out_done;
183 tl_nexus = tl_hba->tl_nexus;
184 if (!tl_nexus) {
185 scmd_printk(KERN_ERR, sc, "TCM_Loop I_T Nexus"
186 " does not exist\n");
187 set_host_byte(sc, DID_ERROR);
188 goto out_done;
191 transport_init_se_cmd(se_cmd, tl_tpg->tl_se_tpg.se_tpg_tfo,
192 tl_nexus->se_sess,
193 scsi_bufflen(sc), sc->sc_data_direction,
194 tcm_loop_sam_attr(sc), &tl_cmd->tl_sense_buf[0]);
196 if (scsi_bidi_cmnd(sc)) {
197 struct scsi_data_buffer *sdb = scsi_in(sc);
199 sgl_bidi = sdb->table.sgl;
200 sgl_bidi_count = sdb->table.nents;
201 se_cmd->se_cmd_flags |= SCF_BIDI;
205 if (transport_lookup_cmd_lun(se_cmd, tl_cmd->sc->device->lun) < 0) {
206 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
207 set_host_byte(sc, DID_NO_CONNECT);
208 goto out_done;
212 * Because some userspace code via scsi-generic do not memset their
213 * associated read buffers, go ahead and do that here for type
214 * SCF_SCSI_CONTROL_SG_IO_CDB. Also note that this is currently
215 * guaranteed to be a single SGL for SCF_SCSI_CONTROL_SG_IO_CDB
216 * by target core in transport_generic_allocate_tasks() ->
217 * transport_generic_cmd_sequencer().
219 if (se_cmd->se_cmd_flags & SCF_SCSI_CONTROL_SG_IO_CDB &&
220 se_cmd->data_direction == DMA_FROM_DEVICE) {
221 struct scatterlist *sg = scsi_sglist(sc);
222 unsigned char *buf = kmap(sg_page(sg)) + sg->offset;
224 if (buf != NULL) {
225 memset(buf, 0, sg->length);
226 kunmap(sg_page(sg));
230 ret = transport_generic_allocate_tasks(se_cmd, sc->cmnd);
231 if (ret == -ENOMEM) {
232 transport_send_check_condition_and_sense(se_cmd,
233 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
234 transport_generic_free_cmd(se_cmd, 0);
235 return;
237 if (ret == -EINVAL) {
238 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
239 tcm_loop_queue_status(se_cmd);
240 else
241 transport_send_check_condition_and_sense(se_cmd,
242 se_cmd->scsi_sense_reason, 0);
243 transport_generic_free_cmd(se_cmd, 0);
244 return;
247 ret = transport_generic_map_mem_to_cmd(se_cmd, scsi_sglist(sc),
248 scsi_sg_count(sc), sgl_bidi, sgl_bidi_count);
249 if (ret) {
250 transport_send_check_condition_and_sense(se_cmd,
251 se_cmd->scsi_sense_reason, 0);
252 transport_generic_free_cmd(se_cmd, 0);
253 return;
255 transport_handle_cdb_direct(se_cmd);
256 return;
258 out_done:
259 sc->scsi_done(sc);
260 return;
264 * ->queuecommand can be and usually is called from interrupt context, so
265 * defer the actual submission to a workqueue.
267 static int tcm_loop_queuecommand(struct Scsi_Host *sh, struct scsi_cmnd *sc)
269 struct tcm_loop_cmd *tl_cmd;
271 pr_debug("tcm_loop_queuecommand() %d:%d:%d:%d got CDB: 0x%02x"
272 " scsi_buf_len: %u\n", sc->device->host->host_no,
273 sc->device->id, sc->device->channel, sc->device->lun,
274 sc->cmnd[0], scsi_bufflen(sc));
276 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC);
277 if (!tl_cmd) {
278 pr_err("Unable to allocate struct tcm_loop_cmd\n");
279 set_host_byte(sc, DID_ERROR);
280 sc->scsi_done(sc);
281 return 0;
284 tl_cmd->sc = sc;
285 INIT_WORK(&tl_cmd->work, tcm_loop_submission_work);
286 queue_work(tcm_loop_workqueue, &tl_cmd->work);
287 return 0;
291 * Called from SCSI EH process context to issue a LUN_RESET TMR
292 * to struct scsi_device
294 static int tcm_loop_device_reset(struct scsi_cmnd *sc)
296 struct se_cmd *se_cmd = NULL;
297 struct se_portal_group *se_tpg;
298 struct se_session *se_sess;
299 struct tcm_loop_cmd *tl_cmd = NULL;
300 struct tcm_loop_hba *tl_hba;
301 struct tcm_loop_nexus *tl_nexus;
302 struct tcm_loop_tmr *tl_tmr = NULL;
303 struct tcm_loop_tpg *tl_tpg;
304 int ret = FAILED, rc;
306 * Locate the tcm_loop_hba_t pointer
308 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
310 * Locate the tl_nexus and se_sess pointers
312 tl_nexus = tl_hba->tl_nexus;
313 if (!tl_nexus) {
314 pr_err("Unable to perform device reset without"
315 " active I_T Nexus\n");
316 return FAILED;
318 se_sess = tl_nexus->se_sess;
320 * Locate the tl_tpg and se_tpg pointers from TargetID in sc->device->id
322 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
323 se_tpg = &tl_tpg->tl_se_tpg;
325 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL);
326 if (!tl_cmd) {
327 pr_err("Unable to allocate memory for tl_cmd\n");
328 return FAILED;
331 tl_tmr = kzalloc(sizeof(struct tcm_loop_tmr), GFP_KERNEL);
332 if (!tl_tmr) {
333 pr_err("Unable to allocate memory for tl_tmr\n");
334 goto release;
336 init_waitqueue_head(&tl_tmr->tl_tmr_wait);
338 se_cmd = &tl_cmd->tl_se_cmd;
340 * Initialize struct se_cmd descriptor from target_core_mod infrastructure
342 transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess, 0,
343 DMA_NONE, MSG_SIMPLE_TAG,
344 &tl_cmd->tl_sense_buf[0]);
346 rc = core_tmr_alloc_req(se_cmd, tl_tmr, TMR_LUN_RESET, GFP_KERNEL);
347 if (rc < 0)
348 goto release;
350 * Locate the underlying TCM struct se_lun from sc->device->lun
352 if (transport_lookup_tmr_lun(se_cmd, sc->device->lun) < 0)
353 goto release;
355 * Queue the TMR to TCM Core and sleep waiting for tcm_loop_queue_tm_rsp()
356 * to wake us up.
358 transport_generic_handle_tmr(se_cmd);
359 wait_event(tl_tmr->tl_tmr_wait, atomic_read(&tl_tmr->tmr_complete));
361 * The TMR LUN_RESET has completed, check the response status and
362 * then release allocations.
364 ret = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
365 SUCCESS : FAILED;
366 release:
367 if (se_cmd)
368 transport_generic_free_cmd(se_cmd, 1);
369 else
370 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
371 kfree(tl_tmr);
372 return ret;
375 static int tcm_loop_slave_alloc(struct scsi_device *sd)
377 set_bit(QUEUE_FLAG_BIDI, &sd->request_queue->queue_flags);
378 return 0;
381 static int tcm_loop_slave_configure(struct scsi_device *sd)
383 return 0;
386 static struct scsi_host_template tcm_loop_driver_template = {
387 .proc_info = tcm_loop_proc_info,
388 .proc_name = "tcm_loopback",
389 .name = "TCM_Loopback",
390 .queuecommand = tcm_loop_queuecommand,
391 .change_queue_depth = tcm_loop_change_queue_depth,
392 .eh_device_reset_handler = tcm_loop_device_reset,
393 .can_queue = 1024,
394 .this_id = -1,
395 .sg_tablesize = 256,
396 .cmd_per_lun = 1024,
397 .max_sectors = 0xFFFF,
398 .use_clustering = DISABLE_CLUSTERING,
399 .slave_alloc = tcm_loop_slave_alloc,
400 .slave_configure = tcm_loop_slave_configure,
401 .module = THIS_MODULE,
404 static int tcm_loop_driver_probe(struct device *dev)
406 struct tcm_loop_hba *tl_hba;
407 struct Scsi_Host *sh;
408 int error;
410 tl_hba = to_tcm_loop_hba(dev);
412 sh = scsi_host_alloc(&tcm_loop_driver_template,
413 sizeof(struct tcm_loop_hba));
414 if (!sh) {
415 pr_err("Unable to allocate struct scsi_host\n");
416 return -ENODEV;
418 tl_hba->sh = sh;
421 * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata
423 *((struct tcm_loop_hba **)sh->hostdata) = tl_hba;
425 * Setup single ID, Channel and LUN for now..
427 sh->max_id = 2;
428 sh->max_lun = 0;
429 sh->max_channel = 0;
430 sh->max_cmd_len = TL_SCSI_MAX_CMD_LEN;
432 error = scsi_add_host(sh, &tl_hba->dev);
433 if (error) {
434 pr_err("%s: scsi_add_host failed\n", __func__);
435 scsi_host_put(sh);
436 return -ENODEV;
438 return 0;
441 static int tcm_loop_driver_remove(struct device *dev)
443 struct tcm_loop_hba *tl_hba;
444 struct Scsi_Host *sh;
446 tl_hba = to_tcm_loop_hba(dev);
447 sh = tl_hba->sh;
449 scsi_remove_host(sh);
450 scsi_host_put(sh);
451 return 0;
454 static void tcm_loop_release_adapter(struct device *dev)
456 struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev);
458 kfree(tl_hba);
462 * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c
464 static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id)
466 int ret;
468 tl_hba->dev.bus = &tcm_loop_lld_bus;
469 tl_hba->dev.parent = tcm_loop_primary;
470 tl_hba->dev.release = &tcm_loop_release_adapter;
471 dev_set_name(&tl_hba->dev, "tcm_loop_adapter_%d", tcm_loop_host_id);
473 ret = device_register(&tl_hba->dev);
474 if (ret) {
475 pr_err("device_register() failed for"
476 " tl_hba->dev: %d\n", ret);
477 return -ENODEV;
480 return 0;
484 * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated
485 * tcm_loop SCSI bus.
487 static int tcm_loop_alloc_core_bus(void)
489 int ret;
491 tcm_loop_primary = root_device_register("tcm_loop_0");
492 if (IS_ERR(tcm_loop_primary)) {
493 pr_err("Unable to allocate tcm_loop_primary\n");
494 return PTR_ERR(tcm_loop_primary);
497 ret = bus_register(&tcm_loop_lld_bus);
498 if (ret) {
499 pr_err("bus_register() failed for tcm_loop_lld_bus\n");
500 goto dev_unreg;
503 ret = driver_register(&tcm_loop_driverfs);
504 if (ret) {
505 pr_err("driver_register() failed for"
506 "tcm_loop_driverfs\n");
507 goto bus_unreg;
510 pr_debug("Initialized TCM Loop Core Bus\n");
511 return ret;
513 bus_unreg:
514 bus_unregister(&tcm_loop_lld_bus);
515 dev_unreg:
516 root_device_unregister(tcm_loop_primary);
517 return ret;
520 static void tcm_loop_release_core_bus(void)
522 driver_unregister(&tcm_loop_driverfs);
523 bus_unregister(&tcm_loop_lld_bus);
524 root_device_unregister(tcm_loop_primary);
526 pr_debug("Releasing TCM Loop Core BUS\n");
529 static char *tcm_loop_get_fabric_name(void)
531 return "loopback";
534 static u8 tcm_loop_get_fabric_proto_ident(struct se_portal_group *se_tpg)
536 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
537 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
539 * tl_proto_id is set at tcm_loop_configfs.c:tcm_loop_make_scsi_hba()
540 * time based on the protocol dependent prefix of the passed configfs group.
542 * Based upon tl_proto_id, TCM_Loop emulates the requested fabric
543 * ProtocolID using target_core_fabric_lib.c symbols.
545 switch (tl_hba->tl_proto_id) {
546 case SCSI_PROTOCOL_SAS:
547 return sas_get_fabric_proto_ident(se_tpg);
548 case SCSI_PROTOCOL_FCP:
549 return fc_get_fabric_proto_ident(se_tpg);
550 case SCSI_PROTOCOL_ISCSI:
551 return iscsi_get_fabric_proto_ident(se_tpg);
552 default:
553 pr_err("Unknown tl_proto_id: 0x%02x, using"
554 " SAS emulation\n", tl_hba->tl_proto_id);
555 break;
558 return sas_get_fabric_proto_ident(se_tpg);
561 static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg)
563 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
565 * Return the passed NAA identifier for the SAS Target Port
567 return &tl_tpg->tl_hba->tl_wwn_address[0];
570 static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg)
572 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
574 * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83
575 * to represent the SCSI Target Port.
577 return tl_tpg->tl_tpgt;
580 static u32 tcm_loop_get_default_depth(struct se_portal_group *se_tpg)
582 return 1;
585 static u32 tcm_loop_get_pr_transport_id(
586 struct se_portal_group *se_tpg,
587 struct se_node_acl *se_nacl,
588 struct t10_pr_registration *pr_reg,
589 int *format_code,
590 unsigned char *buf)
592 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
593 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
595 switch (tl_hba->tl_proto_id) {
596 case SCSI_PROTOCOL_SAS:
597 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
598 format_code, buf);
599 case SCSI_PROTOCOL_FCP:
600 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
601 format_code, buf);
602 case SCSI_PROTOCOL_ISCSI:
603 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
604 format_code, buf);
605 default:
606 pr_err("Unknown tl_proto_id: 0x%02x, using"
607 " SAS emulation\n", tl_hba->tl_proto_id);
608 break;
611 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
612 format_code, buf);
615 static u32 tcm_loop_get_pr_transport_id_len(
616 struct se_portal_group *se_tpg,
617 struct se_node_acl *se_nacl,
618 struct t10_pr_registration *pr_reg,
619 int *format_code)
621 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
622 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
624 switch (tl_hba->tl_proto_id) {
625 case SCSI_PROTOCOL_SAS:
626 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
627 format_code);
628 case SCSI_PROTOCOL_FCP:
629 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
630 format_code);
631 case SCSI_PROTOCOL_ISCSI:
632 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
633 format_code);
634 default:
635 pr_err("Unknown tl_proto_id: 0x%02x, using"
636 " SAS emulation\n", tl_hba->tl_proto_id);
637 break;
640 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
641 format_code);
645 * Used for handling SCSI fabric dependent TransportIDs in SPC-3 and above
646 * Persistent Reservation SPEC_I_PT=1 and PROUT REGISTER_AND_MOVE operations.
648 static char *tcm_loop_parse_pr_out_transport_id(
649 struct se_portal_group *se_tpg,
650 const char *buf,
651 u32 *out_tid_len,
652 char **port_nexus_ptr)
654 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
655 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
657 switch (tl_hba->tl_proto_id) {
658 case SCSI_PROTOCOL_SAS:
659 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
660 port_nexus_ptr);
661 case SCSI_PROTOCOL_FCP:
662 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
663 port_nexus_ptr);
664 case SCSI_PROTOCOL_ISCSI:
665 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
666 port_nexus_ptr);
667 default:
668 pr_err("Unknown tl_proto_id: 0x%02x, using"
669 " SAS emulation\n", tl_hba->tl_proto_id);
670 break;
673 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
674 port_nexus_ptr);
678 * Returning (1) here allows for target_core_mod struct se_node_acl to be generated
679 * based upon the incoming fabric dependent SCSI Initiator Port
681 static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg)
683 return 1;
686 static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg)
688 return 0;
692 * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for
693 * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest
695 static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg)
697 return 0;
701 * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will
702 * never be called for TCM_Loop by target_core_fabric_configfs.c code.
703 * It has been added here as a nop for target_fabric_tf_ops_check()
705 static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg)
707 return 0;
710 static struct se_node_acl *tcm_loop_tpg_alloc_fabric_acl(
711 struct se_portal_group *se_tpg)
713 struct tcm_loop_nacl *tl_nacl;
715 tl_nacl = kzalloc(sizeof(struct tcm_loop_nacl), GFP_KERNEL);
716 if (!tl_nacl) {
717 pr_err("Unable to allocate struct tcm_loop_nacl\n");
718 return NULL;
721 return &tl_nacl->se_node_acl;
724 static void tcm_loop_tpg_release_fabric_acl(
725 struct se_portal_group *se_tpg,
726 struct se_node_acl *se_nacl)
728 struct tcm_loop_nacl *tl_nacl = container_of(se_nacl,
729 struct tcm_loop_nacl, se_node_acl);
731 kfree(tl_nacl);
734 static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg)
736 return 1;
739 static int tcm_loop_is_state_remove(struct se_cmd *se_cmd)
742 * Assume struct scsi_cmnd is not in remove state..
744 return 0;
747 static int tcm_loop_sess_logged_in(struct se_session *se_sess)
750 * Assume that TL Nexus is always active
752 return 1;
755 static u32 tcm_loop_sess_get_index(struct se_session *se_sess)
757 return 1;
760 static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl)
762 return;
765 static u32 tcm_loop_get_task_tag(struct se_cmd *se_cmd)
767 return 1;
770 static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd)
772 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
773 struct tcm_loop_cmd, tl_se_cmd);
775 return tl_cmd->sc_cmd_state;
778 static int tcm_loop_shutdown_session(struct se_session *se_sess)
780 return 0;
783 static void tcm_loop_close_session(struct se_session *se_sess)
785 return;
788 static void tcm_loop_stop_session(
789 struct se_session *se_sess,
790 int sess_sleep,
791 int conn_sleep)
793 return;
796 static void tcm_loop_fall_back_to_erl0(struct se_session *se_sess)
798 return;
801 static int tcm_loop_write_pending(struct se_cmd *se_cmd)
804 * Since Linux/SCSI has already sent down a struct scsi_cmnd
805 * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array
806 * memory, and memory has already been mapped to struct se_cmd->t_mem_list
807 * format with transport_generic_map_mem_to_cmd().
809 * We now tell TCM to add this WRITE CDB directly into the TCM storage
810 * object execution queue.
812 transport_generic_process_write(se_cmd);
813 return 0;
816 static int tcm_loop_write_pending_status(struct se_cmd *se_cmd)
818 return 0;
821 static int tcm_loop_queue_data_in(struct se_cmd *se_cmd)
823 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
824 struct tcm_loop_cmd, tl_se_cmd);
825 struct scsi_cmnd *sc = tl_cmd->sc;
827 pr_debug("tcm_loop_queue_data_in() called for scsi_cmnd: %p"
828 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
830 sc->result = SAM_STAT_GOOD;
831 set_host_byte(sc, DID_OK);
832 sc->scsi_done(sc);
833 return 0;
836 static int tcm_loop_queue_status(struct se_cmd *se_cmd)
838 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
839 struct tcm_loop_cmd, tl_se_cmd);
840 struct scsi_cmnd *sc = tl_cmd->sc;
842 pr_debug("tcm_loop_queue_status() called for scsi_cmnd: %p"
843 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
845 if (se_cmd->sense_buffer &&
846 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
847 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) {
849 memcpy(sc->sense_buffer, se_cmd->sense_buffer,
850 SCSI_SENSE_BUFFERSIZE);
851 sc->result = SAM_STAT_CHECK_CONDITION;
852 set_driver_byte(sc, DRIVER_SENSE);
853 } else
854 sc->result = se_cmd->scsi_status;
856 set_host_byte(sc, DID_OK);
857 sc->scsi_done(sc);
858 return 0;
861 static int tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd)
863 struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
864 struct tcm_loop_tmr *tl_tmr = se_tmr->fabric_tmr_ptr;
866 * The SCSI EH thread will be sleeping on se_tmr->tl_tmr_wait, go ahead
867 * and wake up the wait_queue_head_t in tcm_loop_device_reset()
869 atomic_set(&tl_tmr->tmr_complete, 1);
870 wake_up(&tl_tmr->tl_tmr_wait);
871 return 0;
874 static u16 tcm_loop_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_length)
876 return 0;
879 static u16 tcm_loop_get_fabric_sense_len(void)
881 return 0;
884 static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba)
886 switch (tl_hba->tl_proto_id) {
887 case SCSI_PROTOCOL_SAS:
888 return "SAS";
889 case SCSI_PROTOCOL_FCP:
890 return "FCP";
891 case SCSI_PROTOCOL_ISCSI:
892 return "iSCSI";
893 default:
894 break;
897 return "Unknown";
900 /* Start items for tcm_loop_port_cit */
902 static int tcm_loop_port_link(
903 struct se_portal_group *se_tpg,
904 struct se_lun *lun)
906 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
907 struct tcm_loop_tpg, tl_se_tpg);
908 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
910 atomic_inc(&tl_tpg->tl_tpg_port_count);
911 smp_mb__after_atomic_inc();
913 * Add Linux/SCSI struct scsi_device by HCTL
915 scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun);
917 pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n");
918 return 0;
921 static void tcm_loop_port_unlink(
922 struct se_portal_group *se_tpg,
923 struct se_lun *se_lun)
925 struct scsi_device *sd;
926 struct tcm_loop_hba *tl_hba;
927 struct tcm_loop_tpg *tl_tpg;
929 tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
930 tl_hba = tl_tpg->tl_hba;
932 sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt,
933 se_lun->unpacked_lun);
934 if (!sd) {
935 pr_err("Unable to locate struct scsi_device for %d:%d:"
936 "%d\n", 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun);
937 return;
940 * Remove Linux/SCSI struct scsi_device by HCTL
942 scsi_remove_device(sd);
943 scsi_device_put(sd);
945 atomic_dec(&tl_tpg->tl_tpg_port_count);
946 smp_mb__after_atomic_dec();
948 pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n");
951 /* End items for tcm_loop_port_cit */
953 /* Start items for tcm_loop_nexus_cit */
955 static int tcm_loop_make_nexus(
956 struct tcm_loop_tpg *tl_tpg,
957 const char *name)
959 struct se_portal_group *se_tpg;
960 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
961 struct tcm_loop_nexus *tl_nexus;
962 int ret = -ENOMEM;
964 if (tl_tpg->tl_hba->tl_nexus) {
965 pr_debug("tl_tpg->tl_hba->tl_nexus already exists\n");
966 return -EEXIST;
968 se_tpg = &tl_tpg->tl_se_tpg;
970 tl_nexus = kzalloc(sizeof(struct tcm_loop_nexus), GFP_KERNEL);
971 if (!tl_nexus) {
972 pr_err("Unable to allocate struct tcm_loop_nexus\n");
973 return -ENOMEM;
976 * Initialize the struct se_session pointer
978 tl_nexus->se_sess = transport_init_session();
979 if (IS_ERR(tl_nexus->se_sess)) {
980 ret = PTR_ERR(tl_nexus->se_sess);
981 goto out;
984 * Since we are running in 'demo mode' this call with generate a
985 * struct se_node_acl for the tcm_loop struct se_portal_group with the SCSI
986 * Initiator port name of the passed configfs group 'name'.
988 tl_nexus->se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
989 se_tpg, (unsigned char *)name);
990 if (!tl_nexus->se_sess->se_node_acl) {
991 transport_free_session(tl_nexus->se_sess);
992 goto out;
995 * Now, register the SAS I_T Nexus as active with the call to
996 * transport_register_session()
998 __transport_register_session(se_tpg, tl_nexus->se_sess->se_node_acl,
999 tl_nexus->se_sess, tl_nexus);
1000 tl_tpg->tl_hba->tl_nexus = tl_nexus;
1001 pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated"
1002 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
1003 name);
1004 return 0;
1006 out:
1007 kfree(tl_nexus);
1008 return ret;
1011 static int tcm_loop_drop_nexus(
1012 struct tcm_loop_tpg *tpg)
1014 struct se_session *se_sess;
1015 struct tcm_loop_nexus *tl_nexus;
1016 struct tcm_loop_hba *tl_hba = tpg->tl_hba;
1018 tl_nexus = tpg->tl_hba->tl_nexus;
1019 if (!tl_nexus)
1020 return -ENODEV;
1022 se_sess = tl_nexus->se_sess;
1023 if (!se_sess)
1024 return -ENODEV;
1026 if (atomic_read(&tpg->tl_tpg_port_count)) {
1027 pr_err("Unable to remove TCM_Loop I_T Nexus with"
1028 " active TPG port count: %d\n",
1029 atomic_read(&tpg->tl_tpg_port_count));
1030 return -EPERM;
1033 pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated"
1034 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
1035 tl_nexus->se_sess->se_node_acl->initiatorname);
1037 * Release the SCSI I_T Nexus to the emulated SAS Target Port
1039 transport_deregister_session(tl_nexus->se_sess);
1040 tpg->tl_hba->tl_nexus = NULL;
1041 kfree(tl_nexus);
1042 return 0;
1045 /* End items for tcm_loop_nexus_cit */
1047 static ssize_t tcm_loop_tpg_show_nexus(
1048 struct se_portal_group *se_tpg,
1049 char *page)
1051 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1052 struct tcm_loop_tpg, tl_se_tpg);
1053 struct tcm_loop_nexus *tl_nexus;
1054 ssize_t ret;
1056 tl_nexus = tl_tpg->tl_hba->tl_nexus;
1057 if (!tl_nexus)
1058 return -ENODEV;
1060 ret = snprintf(page, PAGE_SIZE, "%s\n",
1061 tl_nexus->se_sess->se_node_acl->initiatorname);
1063 return ret;
1066 static ssize_t tcm_loop_tpg_store_nexus(
1067 struct se_portal_group *se_tpg,
1068 const char *page,
1069 size_t count)
1071 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1072 struct tcm_loop_tpg, tl_se_tpg);
1073 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
1074 unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr;
1075 int ret;
1077 * Shutdown the active I_T nexus if 'NULL' is passed..
1079 if (!strncmp(page, "NULL", 4)) {
1080 ret = tcm_loop_drop_nexus(tl_tpg);
1081 return (!ret) ? count : ret;
1084 * Otherwise make sure the passed virtual Initiator port WWN matches
1085 * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call
1086 * tcm_loop_make_nexus()
1088 if (strlen(page) >= TL_WWN_ADDR_LEN) {
1089 pr_err("Emulated NAA Sas Address: %s, exceeds"
1090 " max: %d\n", page, TL_WWN_ADDR_LEN);
1091 return -EINVAL;
1093 snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page);
1095 ptr = strstr(i_port, "naa.");
1096 if (ptr) {
1097 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) {
1098 pr_err("Passed SAS Initiator Port %s does not"
1099 " match target port protoid: %s\n", i_port,
1100 tcm_loop_dump_proto_id(tl_hba));
1101 return -EINVAL;
1103 port_ptr = &i_port[0];
1104 goto check_newline;
1106 ptr = strstr(i_port, "fc.");
1107 if (ptr) {
1108 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) {
1109 pr_err("Passed FCP Initiator Port %s does not"
1110 " match target port protoid: %s\n", i_port,
1111 tcm_loop_dump_proto_id(tl_hba));
1112 return -EINVAL;
1114 port_ptr = &i_port[3]; /* Skip over "fc." */
1115 goto check_newline;
1117 ptr = strstr(i_port, "iqn.");
1118 if (ptr) {
1119 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) {
1120 pr_err("Passed iSCSI Initiator Port %s does not"
1121 " match target port protoid: %s\n", i_port,
1122 tcm_loop_dump_proto_id(tl_hba));
1123 return -EINVAL;
1125 port_ptr = &i_port[0];
1126 goto check_newline;
1128 pr_err("Unable to locate prefix for emulated Initiator Port:"
1129 " %s\n", i_port);
1130 return -EINVAL;
1132 * Clear any trailing newline for the NAA WWN
1134 check_newline:
1135 if (i_port[strlen(i_port)-1] == '\n')
1136 i_port[strlen(i_port)-1] = '\0';
1138 ret = tcm_loop_make_nexus(tl_tpg, port_ptr);
1139 if (ret < 0)
1140 return ret;
1142 return count;
1145 TF_TPG_BASE_ATTR(tcm_loop, nexus, S_IRUGO | S_IWUSR);
1147 static struct configfs_attribute *tcm_loop_tpg_attrs[] = {
1148 &tcm_loop_tpg_nexus.attr,
1149 NULL,
1152 /* Start items for tcm_loop_naa_cit */
1154 struct se_portal_group *tcm_loop_make_naa_tpg(
1155 struct se_wwn *wwn,
1156 struct config_group *group,
1157 const char *name)
1159 struct tcm_loop_hba *tl_hba = container_of(wwn,
1160 struct tcm_loop_hba, tl_hba_wwn);
1161 struct tcm_loop_tpg *tl_tpg;
1162 char *tpgt_str, *end_ptr;
1163 int ret;
1164 unsigned short int tpgt;
1166 tpgt_str = strstr(name, "tpgt_");
1167 if (!tpgt_str) {
1168 pr_err("Unable to locate \"tpgt_#\" directory"
1169 " group\n");
1170 return ERR_PTR(-EINVAL);
1172 tpgt_str += 5; /* Skip ahead of "tpgt_" */
1173 tpgt = (unsigned short int) simple_strtoul(tpgt_str, &end_ptr, 0);
1175 if (tpgt >= TL_TPGS_PER_HBA) {
1176 pr_err("Passed tpgt: %hu exceeds TL_TPGS_PER_HBA:"
1177 " %u\n", tpgt, TL_TPGS_PER_HBA);
1178 return ERR_PTR(-EINVAL);
1180 tl_tpg = &tl_hba->tl_hba_tpgs[tpgt];
1181 tl_tpg->tl_hba = tl_hba;
1182 tl_tpg->tl_tpgt = tpgt;
1184 * Register the tl_tpg as a emulated SAS TCM Target Endpoint
1186 ret = core_tpg_register(&tcm_loop_fabric_configfs->tf_ops,
1187 wwn, &tl_tpg->tl_se_tpg, tl_tpg,
1188 TRANSPORT_TPG_TYPE_NORMAL);
1189 if (ret < 0)
1190 return ERR_PTR(-ENOMEM);
1192 pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s"
1193 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1194 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1196 return &tl_tpg->tl_se_tpg;
1199 void tcm_loop_drop_naa_tpg(
1200 struct se_portal_group *se_tpg)
1202 struct se_wwn *wwn = se_tpg->se_tpg_wwn;
1203 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1204 struct tcm_loop_tpg, tl_se_tpg);
1205 struct tcm_loop_hba *tl_hba;
1206 unsigned short tpgt;
1208 tl_hba = tl_tpg->tl_hba;
1209 tpgt = tl_tpg->tl_tpgt;
1211 * Release the I_T Nexus for the Virtual SAS link if present
1213 tcm_loop_drop_nexus(tl_tpg);
1215 * Deregister the tl_tpg as a emulated SAS TCM Target Endpoint
1217 core_tpg_deregister(se_tpg);
1219 tl_tpg->tl_hba = NULL;
1220 tl_tpg->tl_tpgt = 0;
1222 pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s"
1223 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1224 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1227 /* End items for tcm_loop_naa_cit */
1229 /* Start items for tcm_loop_cit */
1231 struct se_wwn *tcm_loop_make_scsi_hba(
1232 struct target_fabric_configfs *tf,
1233 struct config_group *group,
1234 const char *name)
1236 struct tcm_loop_hba *tl_hba;
1237 struct Scsi_Host *sh;
1238 char *ptr;
1239 int ret, off = 0;
1241 tl_hba = kzalloc(sizeof(struct tcm_loop_hba), GFP_KERNEL);
1242 if (!tl_hba) {
1243 pr_err("Unable to allocate struct tcm_loop_hba\n");
1244 return ERR_PTR(-ENOMEM);
1247 * Determine the emulated Protocol Identifier and Target Port Name
1248 * based on the incoming configfs directory name.
1250 ptr = strstr(name, "naa.");
1251 if (ptr) {
1252 tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS;
1253 goto check_len;
1255 ptr = strstr(name, "fc.");
1256 if (ptr) {
1257 tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP;
1258 off = 3; /* Skip over "fc." */
1259 goto check_len;
1261 ptr = strstr(name, "iqn.");
1262 if (!ptr) {
1263 pr_err("Unable to locate prefix for emulated Target "
1264 "Port: %s\n", name);
1265 ret = -EINVAL;
1266 goto out;
1268 tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI;
1270 check_len:
1271 if (strlen(name) >= TL_WWN_ADDR_LEN) {
1272 pr_err("Emulated NAA %s Address: %s, exceeds"
1273 " max: %d\n", name, tcm_loop_dump_proto_id(tl_hba),
1274 TL_WWN_ADDR_LEN);
1275 ret = -EINVAL;
1276 goto out;
1278 snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]);
1281 * Call device_register(tl_hba->dev) to register the emulated
1282 * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after
1283 * device_register() callbacks in tcm_loop_driver_probe()
1285 ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt);
1286 if (ret)
1287 goto out;
1289 sh = tl_hba->sh;
1290 tcm_loop_hba_no_cnt++;
1291 pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target"
1292 " %s Address: %s at Linux/SCSI Host ID: %d\n",
1293 tcm_loop_dump_proto_id(tl_hba), name, sh->host_no);
1295 return &tl_hba->tl_hba_wwn;
1296 out:
1297 kfree(tl_hba);
1298 return ERR_PTR(ret);
1301 void tcm_loop_drop_scsi_hba(
1302 struct se_wwn *wwn)
1304 struct tcm_loop_hba *tl_hba = container_of(wwn,
1305 struct tcm_loop_hba, tl_hba_wwn);
1307 pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target"
1308 " SAS Address: %s at Linux/SCSI Host ID: %d\n",
1309 tl_hba->tl_wwn_address, tl_hba->sh->host_no);
1311 * Call device_unregister() on the original tl_hba->dev.
1312 * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will
1313 * release *tl_hba;
1315 device_unregister(&tl_hba->dev);
1318 /* Start items for tcm_loop_cit */
1319 static ssize_t tcm_loop_wwn_show_attr_version(
1320 struct target_fabric_configfs *tf,
1321 char *page)
1323 return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION);
1326 TF_WWN_ATTR_RO(tcm_loop, version);
1328 static struct configfs_attribute *tcm_loop_wwn_attrs[] = {
1329 &tcm_loop_wwn_version.attr,
1330 NULL,
1333 /* End items for tcm_loop_cit */
1335 static int tcm_loop_register_configfs(void)
1337 struct target_fabric_configfs *fabric;
1338 struct config_group *tf_cg;
1339 int ret;
1341 * Set the TCM Loop HBA counter to zero
1343 tcm_loop_hba_no_cnt = 0;
1345 * Register the top level struct config_item_type with TCM core
1347 fabric = target_fabric_configfs_init(THIS_MODULE, "loopback");
1348 if (IS_ERR(fabric)) {
1349 pr_err("tcm_loop_register_configfs() failed!\n");
1350 return PTR_ERR(fabric);
1353 * Setup the fabric API of function pointers used by target_core_mod
1355 fabric->tf_ops.get_fabric_name = &tcm_loop_get_fabric_name;
1356 fabric->tf_ops.get_fabric_proto_ident = &tcm_loop_get_fabric_proto_ident;
1357 fabric->tf_ops.tpg_get_wwn = &tcm_loop_get_endpoint_wwn;
1358 fabric->tf_ops.tpg_get_tag = &tcm_loop_get_tag;
1359 fabric->tf_ops.tpg_get_default_depth = &tcm_loop_get_default_depth;
1360 fabric->tf_ops.tpg_get_pr_transport_id = &tcm_loop_get_pr_transport_id;
1361 fabric->tf_ops.tpg_get_pr_transport_id_len =
1362 &tcm_loop_get_pr_transport_id_len;
1363 fabric->tf_ops.tpg_parse_pr_out_transport_id =
1364 &tcm_loop_parse_pr_out_transport_id;
1365 fabric->tf_ops.tpg_check_demo_mode = &tcm_loop_check_demo_mode;
1366 fabric->tf_ops.tpg_check_demo_mode_cache =
1367 &tcm_loop_check_demo_mode_cache;
1368 fabric->tf_ops.tpg_check_demo_mode_write_protect =
1369 &tcm_loop_check_demo_mode_write_protect;
1370 fabric->tf_ops.tpg_check_prod_mode_write_protect =
1371 &tcm_loop_check_prod_mode_write_protect;
1373 * The TCM loopback fabric module runs in demo-mode to a local
1374 * virtual SCSI device, so fabric dependent initator ACLs are
1375 * not required.
1377 fabric->tf_ops.tpg_alloc_fabric_acl = &tcm_loop_tpg_alloc_fabric_acl;
1378 fabric->tf_ops.tpg_release_fabric_acl =
1379 &tcm_loop_tpg_release_fabric_acl;
1380 fabric->tf_ops.tpg_get_inst_index = &tcm_loop_get_inst_index;
1382 * Used for setting up remaining TCM resources in process context
1384 fabric->tf_ops.check_stop_free = &tcm_loop_check_stop_free;
1385 fabric->tf_ops.release_cmd = &tcm_loop_release_cmd;
1386 fabric->tf_ops.shutdown_session = &tcm_loop_shutdown_session;
1387 fabric->tf_ops.close_session = &tcm_loop_close_session;
1388 fabric->tf_ops.stop_session = &tcm_loop_stop_session;
1389 fabric->tf_ops.fall_back_to_erl0 = &tcm_loop_fall_back_to_erl0;
1390 fabric->tf_ops.sess_logged_in = &tcm_loop_sess_logged_in;
1391 fabric->tf_ops.sess_get_index = &tcm_loop_sess_get_index;
1392 fabric->tf_ops.sess_get_initiator_sid = NULL;
1393 fabric->tf_ops.write_pending = &tcm_loop_write_pending;
1394 fabric->tf_ops.write_pending_status = &tcm_loop_write_pending_status;
1396 * Not used for TCM loopback
1398 fabric->tf_ops.set_default_node_attributes =
1399 &tcm_loop_set_default_node_attributes;
1400 fabric->tf_ops.get_task_tag = &tcm_loop_get_task_tag;
1401 fabric->tf_ops.get_cmd_state = &tcm_loop_get_cmd_state;
1402 fabric->tf_ops.queue_data_in = &tcm_loop_queue_data_in;
1403 fabric->tf_ops.queue_status = &tcm_loop_queue_status;
1404 fabric->tf_ops.queue_tm_rsp = &tcm_loop_queue_tm_rsp;
1405 fabric->tf_ops.set_fabric_sense_len = &tcm_loop_set_fabric_sense_len;
1406 fabric->tf_ops.get_fabric_sense_len = &tcm_loop_get_fabric_sense_len;
1407 fabric->tf_ops.is_state_remove = &tcm_loop_is_state_remove;
1409 tf_cg = &fabric->tf_group;
1411 * Setup function pointers for generic logic in target_core_fabric_configfs.c
1413 fabric->tf_ops.fabric_make_wwn = &tcm_loop_make_scsi_hba;
1414 fabric->tf_ops.fabric_drop_wwn = &tcm_loop_drop_scsi_hba;
1415 fabric->tf_ops.fabric_make_tpg = &tcm_loop_make_naa_tpg;
1416 fabric->tf_ops.fabric_drop_tpg = &tcm_loop_drop_naa_tpg;
1418 * fabric_post_link() and fabric_pre_unlink() are used for
1419 * registration and release of TCM Loop Virtual SCSI LUNs.
1421 fabric->tf_ops.fabric_post_link = &tcm_loop_port_link;
1422 fabric->tf_ops.fabric_pre_unlink = &tcm_loop_port_unlink;
1423 fabric->tf_ops.fabric_make_np = NULL;
1424 fabric->tf_ops.fabric_drop_np = NULL;
1426 * Setup default attribute lists for various fabric->tf_cit_tmpl
1428 TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = tcm_loop_wwn_attrs;
1429 TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = tcm_loop_tpg_attrs;
1430 TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
1431 TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
1432 TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
1434 * Once fabric->tf_ops has been setup, now register the fabric for
1435 * use within TCM
1437 ret = target_fabric_configfs_register(fabric);
1438 if (ret < 0) {
1439 pr_err("target_fabric_configfs_register() for"
1440 " TCM_Loop failed!\n");
1441 target_fabric_configfs_free(fabric);
1442 return -1;
1445 * Setup our local pointer to *fabric.
1447 tcm_loop_fabric_configfs = fabric;
1448 pr_debug("TCM_LOOP[0] - Set fabric ->"
1449 " tcm_loop_fabric_configfs\n");
1450 return 0;
1453 static void tcm_loop_deregister_configfs(void)
1455 if (!tcm_loop_fabric_configfs)
1456 return;
1458 target_fabric_configfs_deregister(tcm_loop_fabric_configfs);
1459 tcm_loop_fabric_configfs = NULL;
1460 pr_debug("TCM_LOOP[0] - Cleared"
1461 " tcm_loop_fabric_configfs\n");
1464 static int __init tcm_loop_fabric_init(void)
1466 int ret = -ENOMEM;
1468 tcm_loop_workqueue = alloc_workqueue("tcm_loop", 0, 0);
1469 if (!tcm_loop_workqueue)
1470 goto out;
1472 tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache",
1473 sizeof(struct tcm_loop_cmd),
1474 __alignof__(struct tcm_loop_cmd),
1475 0, NULL);
1476 if (!tcm_loop_cmd_cache) {
1477 pr_debug("kmem_cache_create() for"
1478 " tcm_loop_cmd_cache failed\n");
1479 goto out_destroy_workqueue;
1482 ret = tcm_loop_alloc_core_bus();
1483 if (ret)
1484 goto out_destroy_cache;
1486 ret = tcm_loop_register_configfs();
1487 if (ret)
1488 goto out_release_core_bus;
1490 return 0;
1492 out_release_core_bus:
1493 tcm_loop_release_core_bus();
1494 out_destroy_cache:
1495 kmem_cache_destroy(tcm_loop_cmd_cache);
1496 out_destroy_workqueue:
1497 destroy_workqueue(tcm_loop_workqueue);
1498 out:
1499 return ret;
1502 static void __exit tcm_loop_fabric_exit(void)
1504 tcm_loop_deregister_configfs();
1505 tcm_loop_release_core_bus();
1506 kmem_cache_destroy(tcm_loop_cmd_cache);
1507 destroy_workqueue(tcm_loop_workqueue);
1510 MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module");
1511 MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>");
1512 MODULE_LICENSE("GPL");
1513 module_init(tcm_loop_fabric_init);
1514 module_exit(tcm_loop_fabric_exit);