Loading...
1/*******************************************************************************
2 *
3 * This file contains the Linux/SCSI LLD virtual SCSI initiator driver
4 * for emulated SAS initiator ports
5 *
6 * © Copyright 2011-2013 Datera, Inc.
7 *
8 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
9 *
10 * Author: Nicholas A. Bellinger <nab@risingtidesystems.com>
11 *
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.
16 *
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 ****************************************************************************/
22
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>
34
35#include <target/target_core_base.h>
36#include <target/target_core_fabric.h>
37
38#include "tcm_loop.h"
39
40#define to_tcm_loop_hba(hba) container_of(hba, struct tcm_loop_hba, dev)
41
42static struct workqueue_struct *tcm_loop_workqueue;
43static struct kmem_cache *tcm_loop_cmd_cache;
44
45static int tcm_loop_hba_no_cnt;
46
47static int tcm_loop_queue_status(struct se_cmd *se_cmd);
48
49/*
50 * Called from struct target_core_fabric_ops->check_stop_free()
51 */
52static int tcm_loop_check_stop_free(struct se_cmd *se_cmd)
53{
54 return transport_generic_free_cmd(se_cmd, 0);
55}
56
57static void tcm_loop_release_cmd(struct se_cmd *se_cmd)
58{
59 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
60 struct tcm_loop_cmd, tl_se_cmd);
61
62 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
63}
64
65static int tcm_loop_show_info(struct seq_file *m, struct Scsi_Host *host)
66{
67 seq_puts(m, "tcm_loop_proc_info()\n");
68 return 0;
69}
70
71static int tcm_loop_driver_probe(struct device *);
72static int tcm_loop_driver_remove(struct device *);
73
74static int pseudo_lld_bus_match(struct device *dev,
75 struct device_driver *dev_driver)
76{
77 return 1;
78}
79
80static 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,
85};
86
87static struct device_driver tcm_loop_driverfs = {
88 .name = "tcm_loop",
89 .bus = &tcm_loop_lld_bus,
90};
91/*
92 * Used with root_device_register() in tcm_loop_alloc_core_bus() below
93 */
94static struct device *tcm_loop_primary;
95
96static void tcm_loop_submission_work(struct work_struct *work)
97{
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;
107 int rc;
108
109 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
110 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
111
112 /*
113 * Ensure that this tl_tpg reference from the incoming sc->device->id
114 * has already been configured via tcm_loop_make_naa_tpg().
115 */
116 if (!tl_tpg->tl_hba) {
117 set_host_byte(sc, DID_NO_CONNECT);
118 goto out_done;
119 }
120 if (tl_tpg->tl_transport_status == TCM_TRANSPORT_OFFLINE) {
121 set_host_byte(sc, DID_TRANSPORT_DISRUPTED);
122 goto out_done;
123 }
124 tl_nexus = tl_tpg->tl_nexus;
125 if (!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);
129 goto out_done;
130 }
131
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;
136 /*
137 * loopback transport doesn't support
138 * WRITE_GENERATE, READ_STRIP protection
139 * information operations, go ahead unprotected.
140 */
141 transfer_length = scsi_bufflen(sc);
142 }
143
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));
152 if (rc < 0) {
153 set_host_byte(sc, DID_NO_CONNECT);
154 goto out_done;
155 }
156 return;
157
158out_done:
159 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
160 sc->scsi_done(sc);
161}
162
163/*
164 * ->queuecommand can be and usually is called from interrupt context, so
165 * defer the actual submission to a workqueue.
166 */
167static int tcm_loop_queuecommand(struct Scsi_Host *sh, struct scsi_cmnd *sc)
168{
169 struct tcm_loop_cmd *tl_cmd;
170
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],
174 scsi_bufflen(sc));
175
176 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC);
177 if (!tl_cmd) {
178 set_host_byte(sc, DID_ERROR);
179 sc->scsi_done(sc);
180 return 0;
181 }
182
183 tl_cmd->sc = sc;
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);
187 return 0;
188}
189
190/*
191 * Called from SCSI EH process context to issue a LUN_RESET TMR
192 * to struct scsi_device
193 */
194static int tcm_loop_issue_tmr(struct tcm_loop_tpg *tl_tpg,
195 u64 lun, int task, enum tcm_tmreq_table tmr)
196{
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;
202
203 /*
204 * Locate the tl_nexus and se_sess pointers
205 */
206 tl_nexus = tl_tpg->tl_nexus;
207 if (!tl_nexus) {
208 pr_err("Unable to perform device reset without active I_T Nexus\n");
209 return ret;
210 }
211
212 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL);
213 if (!tl_cmd)
214 return ret;
215
216 init_completion(&tl_cmd->tmr_done);
217
218 se_cmd = &tl_cmd->tl_se_cmd;
219 se_sess = tl_tpg->tl_nexus->se_sess;
220
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);
224 if (rc < 0)
225 goto release;
226 wait_for_completion(&tl_cmd->tmr_done);
227 ret = se_cmd->se_tmr_req->response;
228 target_put_sess_cmd(se_cmd);
229
230out:
231 return ret;
232
233release:
234 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
235 goto out;
236}
237
238static int tcm_loop_abort_task(struct scsi_cmnd *sc)
239{
240 struct tcm_loop_hba *tl_hba;
241 struct tcm_loop_tpg *tl_tpg;
242 int ret = FAILED;
243
244 /*
245 * Locate the tcm_loop_hba_t pointer
246 */
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;
252}
253
254/*
255 * Called from SCSI EH process context to issue a LUN_RESET TMR
256 * to struct scsi_device
257 */
258static int tcm_loop_device_reset(struct scsi_cmnd *sc)
259{
260 struct tcm_loop_hba *tl_hba;
261 struct tcm_loop_tpg *tl_tpg;
262 int ret = FAILED;
263
264 /*
265 * Locate the tcm_loop_hba_t pointer
266 */
267 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
268 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
269
270 ret = tcm_loop_issue_tmr(tl_tpg, sc->device->lun,
271 0, TMR_LUN_RESET);
272 return (ret == TMR_FUNCTION_COMPLETE) ? SUCCESS : FAILED;
273}
274
275static int tcm_loop_target_reset(struct scsi_cmnd *sc)
276{
277 struct tcm_loop_hba *tl_hba;
278 struct tcm_loop_tpg *tl_tpg;
279
280 /*
281 * Locate the tcm_loop_hba_t pointer
282 */
283 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
284 if (!tl_hba) {
285 pr_err("Unable to perform device reset without active I_T Nexus\n");
286 return FAILED;
287 }
288 /*
289 * Locate the tl_tpg pointer from TargetID in sc->device->id
290 */
291 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
292 if (tl_tpg) {
293 tl_tpg->tl_transport_status = TCM_TRANSPORT_ONLINE;
294 return SUCCESS;
295 }
296 return FAILED;
297}
298
299static 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,
308 .can_queue = 1024,
309 .this_id = -1,
310 .sg_tablesize = 256,
311 .cmd_per_lun = 1024,
312 .max_sectors = 0xFFFF,
313 .dma_boundary = PAGE_SIZE - 1,
314 .module = THIS_MODULE,
315 .track_queue_depth = 1,
316};
317
318static int tcm_loop_driver_probe(struct device *dev)
319{
320 struct tcm_loop_hba *tl_hba;
321 struct Scsi_Host *sh;
322 int error, host_prot;
323
324 tl_hba = to_tcm_loop_hba(dev);
325
326 sh = scsi_host_alloc(&tcm_loop_driver_template,
327 sizeof(struct tcm_loop_hba));
328 if (!sh) {
329 pr_err("Unable to allocate struct scsi_host\n");
330 return -ENODEV;
331 }
332 tl_hba->sh = sh;
333
334 /*
335 * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata
336 */
337 *((struct tcm_loop_hba **)sh->hostdata) = tl_hba;
338 /*
339 * Setup single ID, Channel and LUN for now..
340 */
341 sh->max_id = 2;
342 sh->max_lun = 0;
343 sh->max_channel = 0;
344 sh->max_cmd_len = SCSI_MAX_VARLEN_CDB_SIZE;
345
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;
349
350 scsi_host_set_prot(sh, host_prot);
351 scsi_host_set_guard(sh, SHOST_DIX_GUARD_CRC);
352
353 error = scsi_add_host(sh, &tl_hba->dev);
354 if (error) {
355 pr_err("%s: scsi_add_host failed\n", __func__);
356 scsi_host_put(sh);
357 return -ENODEV;
358 }
359 return 0;
360}
361
362static int tcm_loop_driver_remove(struct device *dev)
363{
364 struct tcm_loop_hba *tl_hba;
365 struct Scsi_Host *sh;
366
367 tl_hba = to_tcm_loop_hba(dev);
368 sh = tl_hba->sh;
369
370 scsi_remove_host(sh);
371 scsi_host_put(sh);
372 return 0;
373}
374
375static void tcm_loop_release_adapter(struct device *dev)
376{
377 struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev);
378
379 kfree(tl_hba);
380}
381
382/*
383 * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c
384 */
385static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id)
386{
387 int ret;
388
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);
393
394 ret = device_register(&tl_hba->dev);
395 if (ret) {
396 pr_err("device_register() failed for tl_hba->dev: %d\n", ret);
397 return -ENODEV;
398 }
399
400 return 0;
401}
402
403/*
404 * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated
405 * tcm_loop SCSI bus.
406 */
407static int tcm_loop_alloc_core_bus(void)
408{
409 int ret;
410
411 tcm_loop_primary = root_device_register("tcm_loop_0");
412 if (IS_ERR(tcm_loop_primary)) {
413 pr_err("Unable to allocate tcm_loop_primary\n");
414 return PTR_ERR(tcm_loop_primary);
415 }
416
417 ret = bus_register(&tcm_loop_lld_bus);
418 if (ret) {
419 pr_err("bus_register() failed for tcm_loop_lld_bus\n");
420 goto dev_unreg;
421 }
422
423 ret = driver_register(&tcm_loop_driverfs);
424 if (ret) {
425 pr_err("driver_register() failed for tcm_loop_driverfs\n");
426 goto bus_unreg;
427 }
428
429 pr_debug("Initialized TCM Loop Core Bus\n");
430 return ret;
431
432bus_unreg:
433 bus_unregister(&tcm_loop_lld_bus);
434dev_unreg:
435 root_device_unregister(tcm_loop_primary);
436 return ret;
437}
438
439static void tcm_loop_release_core_bus(void)
440{
441 driver_unregister(&tcm_loop_driverfs);
442 bus_unregister(&tcm_loop_lld_bus);
443 root_device_unregister(tcm_loop_primary);
444
445 pr_debug("Releasing TCM Loop Core BUS\n");
446}
447
448static inline struct tcm_loop_tpg *tl_tpg(struct se_portal_group *se_tpg)
449{
450 return container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
451}
452
453static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg)
454{
455 /*
456 * Return the passed NAA identifier for the Target Port
457 */
458 return &tl_tpg(se_tpg)->tl_hba->tl_wwn_address[0];
459}
460
461static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg)
462{
463 /*
464 * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83
465 * to represent the SCSI Target Port.
466 */
467 return tl_tpg(se_tpg)->tl_tpgt;
468}
469
470/*
471 * Returning (1) here allows for target_core_mod struct se_node_acl to be generated
472 * based upon the incoming fabric dependent SCSI Initiator Port
473 */
474static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg)
475{
476 return 1;
477}
478
479static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg)
480{
481 return 0;
482}
483
484/*
485 * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for
486 * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest
487 */
488static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg)
489{
490 return 0;
491}
492
493/*
494 * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will
495 * never be called for TCM_Loop by target_core_fabric_configfs.c code.
496 * It has been added here as a nop for target_fabric_tf_ops_check()
497 */
498static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg)
499{
500 return 0;
501}
502
503static int tcm_loop_check_prot_fabric_only(struct se_portal_group *se_tpg)
504{
505 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg,
506 tl_se_tpg);
507 return tl_tpg->tl_fabric_prot_type;
508}
509
510static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg)
511{
512 return 1;
513}
514
515static u32 tcm_loop_sess_get_index(struct se_session *se_sess)
516{
517 return 1;
518}
519
520static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl)
521{
522 return;
523}
524
525static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd)
526{
527 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
528 struct tcm_loop_cmd, tl_se_cmd);
529
530 return tl_cmd->sc_cmd_state;
531}
532
533static int tcm_loop_write_pending(struct se_cmd *se_cmd)
534{
535 /*
536 * Since Linux/SCSI has already sent down a struct scsi_cmnd
537 * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array
538 * memory, and memory has already been mapped to struct se_cmd->t_mem_list
539 * format with transport_generic_map_mem_to_cmd().
540 *
541 * We now tell TCM to add this WRITE CDB directly into the TCM storage
542 * object execution queue.
543 */
544 target_execute_cmd(se_cmd);
545 return 0;
546}
547
548static int tcm_loop_queue_data_or_status(const char *func,
549 struct se_cmd *se_cmd, u8 scsi_status)
550{
551 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
552 struct tcm_loop_cmd, tl_se_cmd);
553 struct scsi_cmnd *sc = tl_cmd->sc;
554
555 pr_debug("%s() called for scsi_cmnd: %p cdb: 0x%02x\n",
556 func, sc, sc->cmnd[0]);
557
558 if (se_cmd->sense_buffer &&
559 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
560 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) {
561
562 memcpy(sc->sense_buffer, se_cmd->sense_buffer,
563 SCSI_SENSE_BUFFERSIZE);
564 sc->result = SAM_STAT_CHECK_CONDITION;
565 set_driver_byte(sc, DRIVER_SENSE);
566 } else
567 sc->result = scsi_status;
568
569 set_host_byte(sc, DID_OK);
570 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) ||
571 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT))
572 scsi_set_resid(sc, se_cmd->residual_count);
573 sc->scsi_done(sc);
574 return 0;
575}
576
577static int tcm_loop_queue_data_in(struct se_cmd *se_cmd)
578{
579 return tcm_loop_queue_data_or_status(__func__, se_cmd, SAM_STAT_GOOD);
580}
581
582static int tcm_loop_queue_status(struct se_cmd *se_cmd)
583{
584 return tcm_loop_queue_data_or_status(__func__,
585 se_cmd, se_cmd->scsi_status);
586}
587
588static void tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd)
589{
590 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
591 struct tcm_loop_cmd, tl_se_cmd);
592
593 /* Wake up tcm_loop_issue_tmr(). */
594 complete(&tl_cmd->tmr_done);
595}
596
597static void tcm_loop_aborted_task(struct se_cmd *se_cmd)
598{
599 return;
600}
601
602static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba)
603{
604 switch (tl_hba->tl_proto_id) {
605 case SCSI_PROTOCOL_SAS:
606 return "SAS";
607 case SCSI_PROTOCOL_FCP:
608 return "FCP";
609 case SCSI_PROTOCOL_ISCSI:
610 return "iSCSI";
611 default:
612 break;
613 }
614
615 return "Unknown";
616}
617
618/* Start items for tcm_loop_port_cit */
619
620static int tcm_loop_port_link(
621 struct se_portal_group *se_tpg,
622 struct se_lun *lun)
623{
624 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
625 struct tcm_loop_tpg, tl_se_tpg);
626 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
627
628 atomic_inc_mb(&tl_tpg->tl_tpg_port_count);
629 /*
630 * Add Linux/SCSI struct scsi_device by HCTL
631 */
632 scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun);
633
634 pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n");
635 return 0;
636}
637
638static void tcm_loop_port_unlink(
639 struct se_portal_group *se_tpg,
640 struct se_lun *se_lun)
641{
642 struct scsi_device *sd;
643 struct tcm_loop_hba *tl_hba;
644 struct tcm_loop_tpg *tl_tpg;
645
646 tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
647 tl_hba = tl_tpg->tl_hba;
648
649 sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt,
650 se_lun->unpacked_lun);
651 if (!sd) {
652 pr_err("Unable to locate struct scsi_device for %d:%d:%llu\n",
653 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun);
654 return;
655 }
656 /*
657 * Remove Linux/SCSI struct scsi_device by HCTL
658 */
659 scsi_remove_device(sd);
660 scsi_device_put(sd);
661
662 atomic_dec_mb(&tl_tpg->tl_tpg_port_count);
663
664 pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n");
665}
666
667/* End items for tcm_loop_port_cit */
668
669static ssize_t tcm_loop_tpg_attrib_fabric_prot_type_show(
670 struct config_item *item, char *page)
671{
672 struct se_portal_group *se_tpg = attrib_to_tpg(item);
673 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg,
674 tl_se_tpg);
675
676 return sprintf(page, "%d\n", tl_tpg->tl_fabric_prot_type);
677}
678
679static ssize_t tcm_loop_tpg_attrib_fabric_prot_type_store(
680 struct config_item *item, const char *page, size_t count)
681{
682 struct se_portal_group *se_tpg = attrib_to_tpg(item);
683 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg,
684 tl_se_tpg);
685 unsigned long val;
686 int ret = kstrtoul(page, 0, &val);
687
688 if (ret) {
689 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
690 return ret;
691 }
692 if (val != 0 && val != 1 && val != 3) {
693 pr_err("Invalid qla2xxx fabric_prot_type: %lu\n", val);
694 return -EINVAL;
695 }
696 tl_tpg->tl_fabric_prot_type = val;
697
698 return count;
699}
700
701CONFIGFS_ATTR(tcm_loop_tpg_attrib_, fabric_prot_type);
702
703static struct configfs_attribute *tcm_loop_tpg_attrib_attrs[] = {
704 &tcm_loop_tpg_attrib_attr_fabric_prot_type,
705 NULL,
706};
707
708/* Start items for tcm_loop_nexus_cit */
709
710static int tcm_loop_alloc_sess_cb(struct se_portal_group *se_tpg,
711 struct se_session *se_sess, void *p)
712{
713 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
714 struct tcm_loop_tpg, tl_se_tpg);
715
716 tl_tpg->tl_nexus = p;
717 return 0;
718}
719
720static int tcm_loop_make_nexus(
721 struct tcm_loop_tpg *tl_tpg,
722 const char *name)
723{
724 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
725 struct tcm_loop_nexus *tl_nexus;
726 int ret;
727
728 if (tl_tpg->tl_nexus) {
729 pr_debug("tl_tpg->tl_nexus already exists\n");
730 return -EEXIST;
731 }
732
733 tl_nexus = kzalloc(sizeof(*tl_nexus), GFP_KERNEL);
734 if (!tl_nexus)
735 return -ENOMEM;
736
737 tl_nexus->se_sess = target_setup_session(&tl_tpg->tl_se_tpg, 0, 0,
738 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS,
739 name, tl_nexus, tcm_loop_alloc_sess_cb);
740 if (IS_ERR(tl_nexus->se_sess)) {
741 ret = PTR_ERR(tl_nexus->se_sess);
742 kfree(tl_nexus);
743 return ret;
744 }
745
746 pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated %s Initiator Port: %s\n",
747 tcm_loop_dump_proto_id(tl_hba), name);
748 return 0;
749}
750
751static int tcm_loop_drop_nexus(
752 struct tcm_loop_tpg *tpg)
753{
754 struct se_session *se_sess;
755 struct tcm_loop_nexus *tl_nexus;
756
757 tl_nexus = tpg->tl_nexus;
758 if (!tl_nexus)
759 return -ENODEV;
760
761 se_sess = tl_nexus->se_sess;
762 if (!se_sess)
763 return -ENODEV;
764
765 if (atomic_read(&tpg->tl_tpg_port_count)) {
766 pr_err("Unable to remove TCM_Loop I_T Nexus with active TPG port count: %d\n",
767 atomic_read(&tpg->tl_tpg_port_count));
768 return -EPERM;
769 }
770
771 pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated %s Initiator Port: %s\n",
772 tcm_loop_dump_proto_id(tpg->tl_hba),
773 tl_nexus->se_sess->se_node_acl->initiatorname);
774 /*
775 * Release the SCSI I_T Nexus to the emulated Target Port
776 */
777 target_remove_session(se_sess);
778 tpg->tl_nexus = NULL;
779 kfree(tl_nexus);
780 return 0;
781}
782
783/* End items for tcm_loop_nexus_cit */
784
785static ssize_t tcm_loop_tpg_nexus_show(struct config_item *item, char *page)
786{
787 struct se_portal_group *se_tpg = to_tpg(item);
788 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
789 struct tcm_loop_tpg, tl_se_tpg);
790 struct tcm_loop_nexus *tl_nexus;
791 ssize_t ret;
792
793 tl_nexus = tl_tpg->tl_nexus;
794 if (!tl_nexus)
795 return -ENODEV;
796
797 ret = snprintf(page, PAGE_SIZE, "%s\n",
798 tl_nexus->se_sess->se_node_acl->initiatorname);
799
800 return ret;
801}
802
803static ssize_t tcm_loop_tpg_nexus_store(struct config_item *item,
804 const char *page, size_t count)
805{
806 struct se_portal_group *se_tpg = to_tpg(item);
807 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
808 struct tcm_loop_tpg, tl_se_tpg);
809 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
810 unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr;
811 int ret;
812 /*
813 * Shutdown the active I_T nexus if 'NULL' is passed..
814 */
815 if (!strncmp(page, "NULL", 4)) {
816 ret = tcm_loop_drop_nexus(tl_tpg);
817 return (!ret) ? count : ret;
818 }
819 /*
820 * Otherwise make sure the passed virtual Initiator port WWN matches
821 * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call
822 * tcm_loop_make_nexus()
823 */
824 if (strlen(page) >= TL_WWN_ADDR_LEN) {
825 pr_err("Emulated NAA Sas Address: %s, exceeds max: %d\n",
826 page, TL_WWN_ADDR_LEN);
827 return -EINVAL;
828 }
829 snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page);
830
831 ptr = strstr(i_port, "naa.");
832 if (ptr) {
833 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) {
834 pr_err("Passed SAS Initiator Port %s does not match target port protoid: %s\n",
835 i_port, tcm_loop_dump_proto_id(tl_hba));
836 return -EINVAL;
837 }
838 port_ptr = &i_port[0];
839 goto check_newline;
840 }
841 ptr = strstr(i_port, "fc.");
842 if (ptr) {
843 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) {
844 pr_err("Passed FCP Initiator Port %s does not match target port protoid: %s\n",
845 i_port, tcm_loop_dump_proto_id(tl_hba));
846 return -EINVAL;
847 }
848 port_ptr = &i_port[3]; /* Skip over "fc." */
849 goto check_newline;
850 }
851 ptr = strstr(i_port, "iqn.");
852 if (ptr) {
853 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) {
854 pr_err("Passed iSCSI Initiator Port %s does not match target port protoid: %s\n",
855 i_port, tcm_loop_dump_proto_id(tl_hba));
856 return -EINVAL;
857 }
858 port_ptr = &i_port[0];
859 goto check_newline;
860 }
861 pr_err("Unable to locate prefix for emulated Initiator Port: %s\n",
862 i_port);
863 return -EINVAL;
864 /*
865 * Clear any trailing newline for the NAA WWN
866 */
867check_newline:
868 if (i_port[strlen(i_port)-1] == '\n')
869 i_port[strlen(i_port)-1] = '\0';
870
871 ret = tcm_loop_make_nexus(tl_tpg, port_ptr);
872 if (ret < 0)
873 return ret;
874
875 return count;
876}
877
878static ssize_t tcm_loop_tpg_transport_status_show(struct config_item *item,
879 char *page)
880{
881 struct se_portal_group *se_tpg = to_tpg(item);
882 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
883 struct tcm_loop_tpg, tl_se_tpg);
884 const char *status = NULL;
885 ssize_t ret = -EINVAL;
886
887 switch (tl_tpg->tl_transport_status) {
888 case TCM_TRANSPORT_ONLINE:
889 status = "online";
890 break;
891 case TCM_TRANSPORT_OFFLINE:
892 status = "offline";
893 break;
894 default:
895 break;
896 }
897
898 if (status)
899 ret = snprintf(page, PAGE_SIZE, "%s\n", status);
900
901 return ret;
902}
903
904static ssize_t tcm_loop_tpg_transport_status_store(struct config_item *item,
905 const char *page, size_t count)
906{
907 struct se_portal_group *se_tpg = to_tpg(item);
908 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
909 struct tcm_loop_tpg, tl_se_tpg);
910
911 if (!strncmp(page, "online", 6)) {
912 tl_tpg->tl_transport_status = TCM_TRANSPORT_ONLINE;
913 return count;
914 }
915 if (!strncmp(page, "offline", 7)) {
916 tl_tpg->tl_transport_status = TCM_TRANSPORT_OFFLINE;
917 if (tl_tpg->tl_nexus) {
918 struct se_session *tl_sess = tl_tpg->tl_nexus->se_sess;
919
920 core_allocate_nexus_loss_ua(tl_sess->se_node_acl);
921 }
922 return count;
923 }
924 return -EINVAL;
925}
926
927static ssize_t tcm_loop_tpg_address_show(struct config_item *item,
928 char *page)
929{
930 struct se_portal_group *se_tpg = to_tpg(item);
931 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
932 struct tcm_loop_tpg, tl_se_tpg);
933 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
934
935 return snprintf(page, PAGE_SIZE, "%d:0:%d\n",
936 tl_hba->sh->host_no, tl_tpg->tl_tpgt);
937}
938
939CONFIGFS_ATTR(tcm_loop_tpg_, nexus);
940CONFIGFS_ATTR(tcm_loop_tpg_, transport_status);
941CONFIGFS_ATTR_RO(tcm_loop_tpg_, address);
942
943static struct configfs_attribute *tcm_loop_tpg_attrs[] = {
944 &tcm_loop_tpg_attr_nexus,
945 &tcm_loop_tpg_attr_transport_status,
946 &tcm_loop_tpg_attr_address,
947 NULL,
948};
949
950/* Start items for tcm_loop_naa_cit */
951
952static struct se_portal_group *tcm_loop_make_naa_tpg(struct se_wwn *wwn,
953 const char *name)
954{
955 struct tcm_loop_hba *tl_hba = container_of(wwn,
956 struct tcm_loop_hba, tl_hba_wwn);
957 struct tcm_loop_tpg *tl_tpg;
958 int ret;
959 unsigned long tpgt;
960
961 if (strstr(name, "tpgt_") != name) {
962 pr_err("Unable to locate \"tpgt_#\" directory group\n");
963 return ERR_PTR(-EINVAL);
964 }
965 if (kstrtoul(name+5, 10, &tpgt))
966 return ERR_PTR(-EINVAL);
967
968 if (tpgt >= TL_TPGS_PER_HBA) {
969 pr_err("Passed tpgt: %lu exceeds TL_TPGS_PER_HBA: %u\n",
970 tpgt, TL_TPGS_PER_HBA);
971 return ERR_PTR(-EINVAL);
972 }
973 tl_tpg = &tl_hba->tl_hba_tpgs[tpgt];
974 tl_tpg->tl_hba = tl_hba;
975 tl_tpg->tl_tpgt = tpgt;
976 /*
977 * Register the tl_tpg as a emulated TCM Target Endpoint
978 */
979 ret = core_tpg_register(wwn, &tl_tpg->tl_se_tpg, tl_hba->tl_proto_id);
980 if (ret < 0)
981 return ERR_PTR(-ENOMEM);
982
983 pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s Target Port %s,t,0x%04lx\n",
984 tcm_loop_dump_proto_id(tl_hba),
985 config_item_name(&wwn->wwn_group.cg_item), tpgt);
986 return &tl_tpg->tl_se_tpg;
987}
988
989static void tcm_loop_drop_naa_tpg(
990 struct se_portal_group *se_tpg)
991{
992 struct se_wwn *wwn = se_tpg->se_tpg_wwn;
993 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
994 struct tcm_loop_tpg, tl_se_tpg);
995 struct tcm_loop_hba *tl_hba;
996 unsigned short tpgt;
997
998 tl_hba = tl_tpg->tl_hba;
999 tpgt = tl_tpg->tl_tpgt;
1000 /*
1001 * Release the I_T Nexus for the Virtual target link if present
1002 */
1003 tcm_loop_drop_nexus(tl_tpg);
1004 /*
1005 * Deregister the tl_tpg as a emulated TCM Target Endpoint
1006 */
1007 core_tpg_deregister(se_tpg);
1008
1009 tl_tpg->tl_hba = NULL;
1010 tl_tpg->tl_tpgt = 0;
1011
1012 pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s Target Port %s,t,0x%04x\n",
1013 tcm_loop_dump_proto_id(tl_hba),
1014 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1015}
1016
1017/* End items for tcm_loop_naa_cit */
1018
1019/* Start items for tcm_loop_cit */
1020
1021static struct se_wwn *tcm_loop_make_scsi_hba(
1022 struct target_fabric_configfs *tf,
1023 struct config_group *group,
1024 const char *name)
1025{
1026 struct tcm_loop_hba *tl_hba;
1027 struct Scsi_Host *sh;
1028 char *ptr;
1029 int ret, off = 0;
1030
1031 tl_hba = kzalloc(sizeof(*tl_hba), GFP_KERNEL);
1032 if (!tl_hba)
1033 return ERR_PTR(-ENOMEM);
1034
1035 /*
1036 * Determine the emulated Protocol Identifier and Target Port Name
1037 * based on the incoming configfs directory name.
1038 */
1039 ptr = strstr(name, "naa.");
1040 if (ptr) {
1041 tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS;
1042 goto check_len;
1043 }
1044 ptr = strstr(name, "fc.");
1045 if (ptr) {
1046 tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP;
1047 off = 3; /* Skip over "fc." */
1048 goto check_len;
1049 }
1050 ptr = strstr(name, "iqn.");
1051 if (!ptr) {
1052 pr_err("Unable to locate prefix for emulated Target Port: %s\n",
1053 name);
1054 ret = -EINVAL;
1055 goto out;
1056 }
1057 tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI;
1058
1059check_len:
1060 if (strlen(name) >= TL_WWN_ADDR_LEN) {
1061 pr_err("Emulated NAA %s Address: %s, exceeds max: %d\n",
1062 name, tcm_loop_dump_proto_id(tl_hba), TL_WWN_ADDR_LEN);
1063 ret = -EINVAL;
1064 goto out;
1065 }
1066 snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]);
1067
1068 /*
1069 * Call device_register(tl_hba->dev) to register the emulated
1070 * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after
1071 * device_register() callbacks in tcm_loop_driver_probe()
1072 */
1073 ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt);
1074 if (ret)
1075 goto out;
1076
1077 sh = tl_hba->sh;
1078 tcm_loop_hba_no_cnt++;
1079 pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target %s Address: %s at Linux/SCSI Host ID: %d\n",
1080 tcm_loop_dump_proto_id(tl_hba), name, sh->host_no);
1081 return &tl_hba->tl_hba_wwn;
1082out:
1083 kfree(tl_hba);
1084 return ERR_PTR(ret);
1085}
1086
1087static void tcm_loop_drop_scsi_hba(
1088 struct se_wwn *wwn)
1089{
1090 struct tcm_loop_hba *tl_hba = container_of(wwn,
1091 struct tcm_loop_hba, tl_hba_wwn);
1092
1093 pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target %s Address: %s at Linux/SCSI Host ID: %d\n",
1094 tcm_loop_dump_proto_id(tl_hba), tl_hba->tl_wwn_address,
1095 tl_hba->sh->host_no);
1096 /*
1097 * Call device_unregister() on the original tl_hba->dev.
1098 * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will
1099 * release *tl_hba;
1100 */
1101 device_unregister(&tl_hba->dev);
1102}
1103
1104/* Start items for tcm_loop_cit */
1105static ssize_t tcm_loop_wwn_version_show(struct config_item *item, char *page)
1106{
1107 return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION);
1108}
1109
1110CONFIGFS_ATTR_RO(tcm_loop_wwn_, version);
1111
1112static struct configfs_attribute *tcm_loop_wwn_attrs[] = {
1113 &tcm_loop_wwn_attr_version,
1114 NULL,
1115};
1116
1117/* End items for tcm_loop_cit */
1118
1119static const struct target_core_fabric_ops loop_ops = {
1120 .module = THIS_MODULE,
1121 .fabric_name = "loopback",
1122 .tpg_get_wwn = tcm_loop_get_endpoint_wwn,
1123 .tpg_get_tag = tcm_loop_get_tag,
1124 .tpg_check_demo_mode = tcm_loop_check_demo_mode,
1125 .tpg_check_demo_mode_cache = tcm_loop_check_demo_mode_cache,
1126 .tpg_check_demo_mode_write_protect =
1127 tcm_loop_check_demo_mode_write_protect,
1128 .tpg_check_prod_mode_write_protect =
1129 tcm_loop_check_prod_mode_write_protect,
1130 .tpg_check_prot_fabric_only = tcm_loop_check_prot_fabric_only,
1131 .tpg_get_inst_index = tcm_loop_get_inst_index,
1132 .check_stop_free = tcm_loop_check_stop_free,
1133 .release_cmd = tcm_loop_release_cmd,
1134 .sess_get_index = tcm_loop_sess_get_index,
1135 .write_pending = tcm_loop_write_pending,
1136 .set_default_node_attributes = tcm_loop_set_default_node_attributes,
1137 .get_cmd_state = tcm_loop_get_cmd_state,
1138 .queue_data_in = tcm_loop_queue_data_in,
1139 .queue_status = tcm_loop_queue_status,
1140 .queue_tm_rsp = tcm_loop_queue_tm_rsp,
1141 .aborted_task = tcm_loop_aborted_task,
1142 .fabric_make_wwn = tcm_loop_make_scsi_hba,
1143 .fabric_drop_wwn = tcm_loop_drop_scsi_hba,
1144 .fabric_make_tpg = tcm_loop_make_naa_tpg,
1145 .fabric_drop_tpg = tcm_loop_drop_naa_tpg,
1146 .fabric_post_link = tcm_loop_port_link,
1147 .fabric_pre_unlink = tcm_loop_port_unlink,
1148 .tfc_wwn_attrs = tcm_loop_wwn_attrs,
1149 .tfc_tpg_base_attrs = tcm_loop_tpg_attrs,
1150 .tfc_tpg_attrib_attrs = tcm_loop_tpg_attrib_attrs,
1151};
1152
1153static int __init tcm_loop_fabric_init(void)
1154{
1155 int ret = -ENOMEM;
1156
1157 tcm_loop_workqueue = alloc_workqueue("tcm_loop", 0, 0);
1158 if (!tcm_loop_workqueue)
1159 goto out;
1160
1161 tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache",
1162 sizeof(struct tcm_loop_cmd),
1163 __alignof__(struct tcm_loop_cmd),
1164 0, NULL);
1165 if (!tcm_loop_cmd_cache) {
1166 pr_debug("kmem_cache_create() for tcm_loop_cmd_cache failed\n");
1167 goto out_destroy_workqueue;
1168 }
1169
1170 ret = tcm_loop_alloc_core_bus();
1171 if (ret)
1172 goto out_destroy_cache;
1173
1174 ret = target_register_template(&loop_ops);
1175 if (ret)
1176 goto out_release_core_bus;
1177
1178 return 0;
1179
1180out_release_core_bus:
1181 tcm_loop_release_core_bus();
1182out_destroy_cache:
1183 kmem_cache_destroy(tcm_loop_cmd_cache);
1184out_destroy_workqueue:
1185 destroy_workqueue(tcm_loop_workqueue);
1186out:
1187 return ret;
1188}
1189
1190static void __exit tcm_loop_fabric_exit(void)
1191{
1192 target_unregister_template(&loop_ops);
1193 tcm_loop_release_core_bus();
1194 kmem_cache_destroy(tcm_loop_cmd_cache);
1195 destroy_workqueue(tcm_loop_workqueue);
1196}
1197
1198MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module");
1199MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>");
1200MODULE_LICENSE("GPL");
1201module_init(tcm_loop_fabric_init);
1202module_exit(tcm_loop_fabric_exit);
1/*******************************************************************************
2 *
3 * This file contains the Linux/SCSI LLD virtual SCSI initiator driver
4 * for emulated SAS initiator ports
5 *
6 * © Copyright 2011 RisingTide Systems LLC.
7 *
8 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
9 *
10 * Author: Nicholas A. Bellinger <nab@risingtidesystems.com>
11 *
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.
16 *
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 ****************************************************************************/
22
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>
34
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>
39
40#include "tcm_loop.h"
41
42#define to_tcm_loop_hba(hba) container_of(hba, struct tcm_loop_hba, dev)
43
44/* Local pointer to allocated TCM configfs fabric module */
45static struct target_fabric_configfs *tcm_loop_fabric_configfs;
46
47static struct workqueue_struct *tcm_loop_workqueue;
48static struct kmem_cache *tcm_loop_cmd_cache;
49
50static int tcm_loop_hba_no_cnt;
51
52static int tcm_loop_queue_status(struct se_cmd *se_cmd);
53
54/*
55 * Called from struct target_core_fabric_ops->check_stop_free()
56 */
57static int tcm_loop_check_stop_free(struct se_cmd *se_cmd)
58{
59 /*
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().
63 */
64 if (se_cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)
65 return 0;
66 /*
67 * Release the struct se_cmd, which will make a callback to release
68 * struct tcm_loop_cmd * in tcm_loop_deallocate_core_cmd()
69 */
70 transport_generic_free_cmd(se_cmd, 0);
71 return 1;
72}
73
74static void tcm_loop_release_cmd(struct se_cmd *se_cmd)
75{
76 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
77 struct tcm_loop_cmd, tl_se_cmd);
78
79 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
80}
81
82static int tcm_loop_proc_info(struct Scsi_Host *host, char *buffer,
83 char **start, off_t offset,
84 int length, int inout)
85{
86 return sprintf(buffer, "tcm_loop_proc_info()\n");
87}
88
89static int tcm_loop_driver_probe(struct device *);
90static int tcm_loop_driver_remove(struct device *);
91
92static int pseudo_lld_bus_match(struct device *dev,
93 struct device_driver *dev_driver)
94{
95 return 1;
96}
97
98static 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,
103};
104
105static struct device_driver tcm_loop_driverfs = {
106 .name = "tcm_loop",
107 .bus = &tcm_loop_lld_bus,
108};
109/*
110 * Used with root_device_register() in tcm_loop_alloc_core_bus() below
111 */
112struct device *tcm_loop_primary;
113
114/*
115 * Copied from drivers/scsi/libfc/fc_fcp.c:fc_change_queue_depth() and
116 * drivers/scsi/libiscsi.c:iscsi_change_queue_depth()
117 */
118static int tcm_loop_change_queue_depth(
119 struct scsi_device *sdev,
120 int depth,
121 int reason)
122{
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;
135 }
136 return sdev->queue_depth;
137}
138
139/*
140 * Locate the SAM Task Attr from struct scsi_cmnd *
141 */
142static int tcm_loop_sam_attr(struct scsi_cmnd *sc)
143{
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;
152 }
153 }
154
155 return MSG_SIMPLE_TAG;
156}
157
158static void tcm_loop_submission_work(struct work_struct *work)
159{
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;
170
171 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
172 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
173
174 /*
175 * Ensure that this tl_tpg reference from the incoming sc->device->id
176 * has already been configured via tcm_loop_make_naa_tpg().
177 */
178 if (!tl_tpg->tl_hba) {
179 set_host_byte(sc, DID_NO_CONNECT);
180 goto out_done;
181 }
182
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;
189 }
190
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]);
195
196 if (scsi_bidi_cmnd(sc)) {
197 struct scsi_data_buffer *sdb = scsi_in(sc);
198
199 sgl_bidi = sdb->table.sgl;
200 sgl_bidi_count = sdb->table.nents;
201 se_cmd->se_cmd_flags |= SCF_BIDI;
202
203 }
204
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;
209 }
210
211 /*
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 target_setup_cmd_from_cdb() ->
217 * transport_generic_cmd_sequencer().
218 */
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;
223
224 if (buf != NULL) {
225 memset(buf, 0, sg->length);
226 kunmap(sg_page(sg));
227 }
228 }
229
230 ret = target_setup_cmd_from_cdb(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;
236 } else if (ret < 0) {
237 if (se_cmd->se_cmd_flags & SCF_SCSI_RESERVATION_CONFLICT)
238 tcm_loop_queue_status(se_cmd);
239 else
240 transport_send_check_condition_and_sense(se_cmd,
241 se_cmd->scsi_sense_reason, 0);
242 transport_generic_free_cmd(se_cmd, 0);
243 return;
244 }
245
246 ret = transport_generic_map_mem_to_cmd(se_cmd, scsi_sglist(sc),
247 scsi_sg_count(sc), sgl_bidi, sgl_bidi_count);
248 if (ret) {
249 transport_send_check_condition_and_sense(se_cmd,
250 se_cmd->scsi_sense_reason, 0);
251 transport_generic_free_cmd(se_cmd, 0);
252 return;
253 }
254 transport_handle_cdb_direct(se_cmd);
255 return;
256
257out_done:
258 sc->scsi_done(sc);
259 return;
260}
261
262/*
263 * ->queuecommand can be and usually is called from interrupt context, so
264 * defer the actual submission to a workqueue.
265 */
266static int tcm_loop_queuecommand(struct Scsi_Host *sh, struct scsi_cmnd *sc)
267{
268 struct tcm_loop_cmd *tl_cmd;
269
270 pr_debug("tcm_loop_queuecommand() %d:%d:%d:%d got CDB: 0x%02x"
271 " scsi_buf_len: %u\n", sc->device->host->host_no,
272 sc->device->id, sc->device->channel, sc->device->lun,
273 sc->cmnd[0], scsi_bufflen(sc));
274
275 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC);
276 if (!tl_cmd) {
277 pr_err("Unable to allocate struct tcm_loop_cmd\n");
278 set_host_byte(sc, DID_ERROR);
279 sc->scsi_done(sc);
280 return 0;
281 }
282
283 tl_cmd->sc = sc;
284 INIT_WORK(&tl_cmd->work, tcm_loop_submission_work);
285 queue_work(tcm_loop_workqueue, &tl_cmd->work);
286 return 0;
287}
288
289/*
290 * Called from SCSI EH process context to issue a LUN_RESET TMR
291 * to struct scsi_device
292 */
293static int tcm_loop_device_reset(struct scsi_cmnd *sc)
294{
295 struct se_cmd *se_cmd = NULL;
296 struct se_portal_group *se_tpg;
297 struct se_session *se_sess;
298 struct tcm_loop_cmd *tl_cmd = NULL;
299 struct tcm_loop_hba *tl_hba;
300 struct tcm_loop_nexus *tl_nexus;
301 struct tcm_loop_tmr *tl_tmr = NULL;
302 struct tcm_loop_tpg *tl_tpg;
303 int ret = FAILED, rc;
304 /*
305 * Locate the tcm_loop_hba_t pointer
306 */
307 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
308 /*
309 * Locate the tl_nexus and se_sess pointers
310 */
311 tl_nexus = tl_hba->tl_nexus;
312 if (!tl_nexus) {
313 pr_err("Unable to perform device reset without"
314 " active I_T Nexus\n");
315 return FAILED;
316 }
317 se_sess = tl_nexus->se_sess;
318 /*
319 * Locate the tl_tpg and se_tpg pointers from TargetID in sc->device->id
320 */
321 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
322 se_tpg = &tl_tpg->tl_se_tpg;
323
324 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL);
325 if (!tl_cmd) {
326 pr_err("Unable to allocate memory for tl_cmd\n");
327 return FAILED;
328 }
329
330 tl_tmr = kzalloc(sizeof(struct tcm_loop_tmr), GFP_KERNEL);
331 if (!tl_tmr) {
332 pr_err("Unable to allocate memory for tl_tmr\n");
333 goto release;
334 }
335 init_waitqueue_head(&tl_tmr->tl_tmr_wait);
336
337 se_cmd = &tl_cmd->tl_se_cmd;
338 /*
339 * Initialize struct se_cmd descriptor from target_core_mod infrastructure
340 */
341 transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess, 0,
342 DMA_NONE, MSG_SIMPLE_TAG,
343 &tl_cmd->tl_sense_buf[0]);
344
345 rc = core_tmr_alloc_req(se_cmd, tl_tmr, TMR_LUN_RESET, GFP_KERNEL);
346 if (rc < 0)
347 goto release;
348 /*
349 * Locate the underlying TCM struct se_lun from sc->device->lun
350 */
351 if (transport_lookup_tmr_lun(se_cmd, sc->device->lun) < 0)
352 goto release;
353 /*
354 * Queue the TMR to TCM Core and sleep waiting for tcm_loop_queue_tm_rsp()
355 * to wake us up.
356 */
357 transport_generic_handle_tmr(se_cmd);
358 wait_event(tl_tmr->tl_tmr_wait, atomic_read(&tl_tmr->tmr_complete));
359 /*
360 * The TMR LUN_RESET has completed, check the response status and
361 * then release allocations.
362 */
363 ret = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
364 SUCCESS : FAILED;
365release:
366 if (se_cmd)
367 transport_generic_free_cmd(se_cmd, 1);
368 else
369 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
370 kfree(tl_tmr);
371 return ret;
372}
373
374static int tcm_loop_slave_alloc(struct scsi_device *sd)
375{
376 set_bit(QUEUE_FLAG_BIDI, &sd->request_queue->queue_flags);
377 return 0;
378}
379
380static int tcm_loop_slave_configure(struct scsi_device *sd)
381{
382 return 0;
383}
384
385static struct scsi_host_template tcm_loop_driver_template = {
386 .proc_info = tcm_loop_proc_info,
387 .proc_name = "tcm_loopback",
388 .name = "TCM_Loopback",
389 .queuecommand = tcm_loop_queuecommand,
390 .change_queue_depth = tcm_loop_change_queue_depth,
391 .eh_device_reset_handler = tcm_loop_device_reset,
392 .can_queue = 1024,
393 .this_id = -1,
394 .sg_tablesize = 256,
395 .cmd_per_lun = 1024,
396 .max_sectors = 0xFFFF,
397 .use_clustering = DISABLE_CLUSTERING,
398 .slave_alloc = tcm_loop_slave_alloc,
399 .slave_configure = tcm_loop_slave_configure,
400 .module = THIS_MODULE,
401};
402
403static int tcm_loop_driver_probe(struct device *dev)
404{
405 struct tcm_loop_hba *tl_hba;
406 struct Scsi_Host *sh;
407 int error;
408
409 tl_hba = to_tcm_loop_hba(dev);
410
411 sh = scsi_host_alloc(&tcm_loop_driver_template,
412 sizeof(struct tcm_loop_hba));
413 if (!sh) {
414 pr_err("Unable to allocate struct scsi_host\n");
415 return -ENODEV;
416 }
417 tl_hba->sh = sh;
418
419 /*
420 * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata
421 */
422 *((struct tcm_loop_hba **)sh->hostdata) = tl_hba;
423 /*
424 * Setup single ID, Channel and LUN for now..
425 */
426 sh->max_id = 2;
427 sh->max_lun = 0;
428 sh->max_channel = 0;
429 sh->max_cmd_len = TL_SCSI_MAX_CMD_LEN;
430
431 error = scsi_add_host(sh, &tl_hba->dev);
432 if (error) {
433 pr_err("%s: scsi_add_host failed\n", __func__);
434 scsi_host_put(sh);
435 return -ENODEV;
436 }
437 return 0;
438}
439
440static int tcm_loop_driver_remove(struct device *dev)
441{
442 struct tcm_loop_hba *tl_hba;
443 struct Scsi_Host *sh;
444
445 tl_hba = to_tcm_loop_hba(dev);
446 sh = tl_hba->sh;
447
448 scsi_remove_host(sh);
449 scsi_host_put(sh);
450 return 0;
451}
452
453static void tcm_loop_release_adapter(struct device *dev)
454{
455 struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev);
456
457 kfree(tl_hba);
458}
459
460/*
461 * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c
462 */
463static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id)
464{
465 int ret;
466
467 tl_hba->dev.bus = &tcm_loop_lld_bus;
468 tl_hba->dev.parent = tcm_loop_primary;
469 tl_hba->dev.release = &tcm_loop_release_adapter;
470 dev_set_name(&tl_hba->dev, "tcm_loop_adapter_%d", tcm_loop_host_id);
471
472 ret = device_register(&tl_hba->dev);
473 if (ret) {
474 pr_err("device_register() failed for"
475 " tl_hba->dev: %d\n", ret);
476 return -ENODEV;
477 }
478
479 return 0;
480}
481
482/*
483 * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated
484 * tcm_loop SCSI bus.
485 */
486static int tcm_loop_alloc_core_bus(void)
487{
488 int ret;
489
490 tcm_loop_primary = root_device_register("tcm_loop_0");
491 if (IS_ERR(tcm_loop_primary)) {
492 pr_err("Unable to allocate tcm_loop_primary\n");
493 return PTR_ERR(tcm_loop_primary);
494 }
495
496 ret = bus_register(&tcm_loop_lld_bus);
497 if (ret) {
498 pr_err("bus_register() failed for tcm_loop_lld_bus\n");
499 goto dev_unreg;
500 }
501
502 ret = driver_register(&tcm_loop_driverfs);
503 if (ret) {
504 pr_err("driver_register() failed for"
505 "tcm_loop_driverfs\n");
506 goto bus_unreg;
507 }
508
509 pr_debug("Initialized TCM Loop Core Bus\n");
510 return ret;
511
512bus_unreg:
513 bus_unregister(&tcm_loop_lld_bus);
514dev_unreg:
515 root_device_unregister(tcm_loop_primary);
516 return ret;
517}
518
519static void tcm_loop_release_core_bus(void)
520{
521 driver_unregister(&tcm_loop_driverfs);
522 bus_unregister(&tcm_loop_lld_bus);
523 root_device_unregister(tcm_loop_primary);
524
525 pr_debug("Releasing TCM Loop Core BUS\n");
526}
527
528static char *tcm_loop_get_fabric_name(void)
529{
530 return "loopback";
531}
532
533static u8 tcm_loop_get_fabric_proto_ident(struct se_portal_group *se_tpg)
534{
535 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
536 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
537 /*
538 * tl_proto_id is set at tcm_loop_configfs.c:tcm_loop_make_scsi_hba()
539 * time based on the protocol dependent prefix of the passed configfs group.
540 *
541 * Based upon tl_proto_id, TCM_Loop emulates the requested fabric
542 * ProtocolID using target_core_fabric_lib.c symbols.
543 */
544 switch (tl_hba->tl_proto_id) {
545 case SCSI_PROTOCOL_SAS:
546 return sas_get_fabric_proto_ident(se_tpg);
547 case SCSI_PROTOCOL_FCP:
548 return fc_get_fabric_proto_ident(se_tpg);
549 case SCSI_PROTOCOL_ISCSI:
550 return iscsi_get_fabric_proto_ident(se_tpg);
551 default:
552 pr_err("Unknown tl_proto_id: 0x%02x, using"
553 " SAS emulation\n", tl_hba->tl_proto_id);
554 break;
555 }
556
557 return sas_get_fabric_proto_ident(se_tpg);
558}
559
560static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg)
561{
562 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
563 /*
564 * Return the passed NAA identifier for the SAS Target Port
565 */
566 return &tl_tpg->tl_hba->tl_wwn_address[0];
567}
568
569static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg)
570{
571 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
572 /*
573 * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83
574 * to represent the SCSI Target Port.
575 */
576 return tl_tpg->tl_tpgt;
577}
578
579static u32 tcm_loop_get_default_depth(struct se_portal_group *se_tpg)
580{
581 return 1;
582}
583
584static u32 tcm_loop_get_pr_transport_id(
585 struct se_portal_group *se_tpg,
586 struct se_node_acl *se_nacl,
587 struct t10_pr_registration *pr_reg,
588 int *format_code,
589 unsigned char *buf)
590{
591 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
592 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
593
594 switch (tl_hba->tl_proto_id) {
595 case SCSI_PROTOCOL_SAS:
596 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
597 format_code, buf);
598 case SCSI_PROTOCOL_FCP:
599 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
600 format_code, buf);
601 case SCSI_PROTOCOL_ISCSI:
602 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
603 format_code, buf);
604 default:
605 pr_err("Unknown tl_proto_id: 0x%02x, using"
606 " SAS emulation\n", tl_hba->tl_proto_id);
607 break;
608 }
609
610 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
611 format_code, buf);
612}
613
614static u32 tcm_loop_get_pr_transport_id_len(
615 struct se_portal_group *se_tpg,
616 struct se_node_acl *se_nacl,
617 struct t10_pr_registration *pr_reg,
618 int *format_code)
619{
620 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
621 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
622
623 switch (tl_hba->tl_proto_id) {
624 case SCSI_PROTOCOL_SAS:
625 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
626 format_code);
627 case SCSI_PROTOCOL_FCP:
628 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
629 format_code);
630 case SCSI_PROTOCOL_ISCSI:
631 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
632 format_code);
633 default:
634 pr_err("Unknown tl_proto_id: 0x%02x, using"
635 " SAS emulation\n", tl_hba->tl_proto_id);
636 break;
637 }
638
639 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
640 format_code);
641}
642
643/*
644 * Used for handling SCSI fabric dependent TransportIDs in SPC-3 and above
645 * Persistent Reservation SPEC_I_PT=1 and PROUT REGISTER_AND_MOVE operations.
646 */
647static char *tcm_loop_parse_pr_out_transport_id(
648 struct se_portal_group *se_tpg,
649 const char *buf,
650 u32 *out_tid_len,
651 char **port_nexus_ptr)
652{
653 struct tcm_loop_tpg *tl_tpg = se_tpg->se_tpg_fabric_ptr;
654 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
655
656 switch (tl_hba->tl_proto_id) {
657 case SCSI_PROTOCOL_SAS:
658 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
659 port_nexus_ptr);
660 case SCSI_PROTOCOL_FCP:
661 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
662 port_nexus_ptr);
663 case SCSI_PROTOCOL_ISCSI:
664 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
665 port_nexus_ptr);
666 default:
667 pr_err("Unknown tl_proto_id: 0x%02x, using"
668 " SAS emulation\n", tl_hba->tl_proto_id);
669 break;
670 }
671
672 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
673 port_nexus_ptr);
674}
675
676/*
677 * Returning (1) here allows for target_core_mod struct se_node_acl to be generated
678 * based upon the incoming fabric dependent SCSI Initiator Port
679 */
680static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg)
681{
682 return 1;
683}
684
685static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg)
686{
687 return 0;
688}
689
690/*
691 * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for
692 * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest
693 */
694static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg)
695{
696 return 0;
697}
698
699/*
700 * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will
701 * never be called for TCM_Loop by target_core_fabric_configfs.c code.
702 * It has been added here as a nop for target_fabric_tf_ops_check()
703 */
704static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg)
705{
706 return 0;
707}
708
709static struct se_node_acl *tcm_loop_tpg_alloc_fabric_acl(
710 struct se_portal_group *se_tpg)
711{
712 struct tcm_loop_nacl *tl_nacl;
713
714 tl_nacl = kzalloc(sizeof(struct tcm_loop_nacl), GFP_KERNEL);
715 if (!tl_nacl) {
716 pr_err("Unable to allocate struct tcm_loop_nacl\n");
717 return NULL;
718 }
719
720 return &tl_nacl->se_node_acl;
721}
722
723static void tcm_loop_tpg_release_fabric_acl(
724 struct se_portal_group *se_tpg,
725 struct se_node_acl *se_nacl)
726{
727 struct tcm_loop_nacl *tl_nacl = container_of(se_nacl,
728 struct tcm_loop_nacl, se_node_acl);
729
730 kfree(tl_nacl);
731}
732
733static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg)
734{
735 return 1;
736}
737
738static u32 tcm_loop_sess_get_index(struct se_session *se_sess)
739{
740 return 1;
741}
742
743static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl)
744{
745 return;
746}
747
748static u32 tcm_loop_get_task_tag(struct se_cmd *se_cmd)
749{
750 return 1;
751}
752
753static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd)
754{
755 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
756 struct tcm_loop_cmd, tl_se_cmd);
757
758 return tl_cmd->sc_cmd_state;
759}
760
761static int tcm_loop_shutdown_session(struct se_session *se_sess)
762{
763 return 0;
764}
765
766static void tcm_loop_close_session(struct se_session *se_sess)
767{
768 return;
769};
770
771static int tcm_loop_write_pending(struct se_cmd *se_cmd)
772{
773 /*
774 * Since Linux/SCSI has already sent down a struct scsi_cmnd
775 * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array
776 * memory, and memory has already been mapped to struct se_cmd->t_mem_list
777 * format with transport_generic_map_mem_to_cmd().
778 *
779 * We now tell TCM to add this WRITE CDB directly into the TCM storage
780 * object execution queue.
781 */
782 transport_generic_process_write(se_cmd);
783 return 0;
784}
785
786static int tcm_loop_write_pending_status(struct se_cmd *se_cmd)
787{
788 return 0;
789}
790
791static int tcm_loop_queue_data_in(struct se_cmd *se_cmd)
792{
793 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
794 struct tcm_loop_cmd, tl_se_cmd);
795 struct scsi_cmnd *sc = tl_cmd->sc;
796
797 pr_debug("tcm_loop_queue_data_in() called for scsi_cmnd: %p"
798 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
799
800 sc->result = SAM_STAT_GOOD;
801 set_host_byte(sc, DID_OK);
802 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) ||
803 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT))
804 scsi_set_resid(sc, se_cmd->residual_count);
805 sc->scsi_done(sc);
806 return 0;
807}
808
809static int tcm_loop_queue_status(struct se_cmd *se_cmd)
810{
811 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
812 struct tcm_loop_cmd, tl_se_cmd);
813 struct scsi_cmnd *sc = tl_cmd->sc;
814
815 pr_debug("tcm_loop_queue_status() called for scsi_cmnd: %p"
816 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
817
818 if (se_cmd->sense_buffer &&
819 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
820 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) {
821
822 memcpy(sc->sense_buffer, se_cmd->sense_buffer,
823 SCSI_SENSE_BUFFERSIZE);
824 sc->result = SAM_STAT_CHECK_CONDITION;
825 set_driver_byte(sc, DRIVER_SENSE);
826 } else
827 sc->result = se_cmd->scsi_status;
828
829 set_host_byte(sc, DID_OK);
830 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) ||
831 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT))
832 scsi_set_resid(sc, se_cmd->residual_count);
833 sc->scsi_done(sc);
834 return 0;
835}
836
837static int tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd)
838{
839 struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
840 struct tcm_loop_tmr *tl_tmr = se_tmr->fabric_tmr_ptr;
841 /*
842 * The SCSI EH thread will be sleeping on se_tmr->tl_tmr_wait, go ahead
843 * and wake up the wait_queue_head_t in tcm_loop_device_reset()
844 */
845 atomic_set(&tl_tmr->tmr_complete, 1);
846 wake_up(&tl_tmr->tl_tmr_wait);
847 return 0;
848}
849
850static u16 tcm_loop_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_length)
851{
852 return 0;
853}
854
855static u16 tcm_loop_get_fabric_sense_len(void)
856{
857 return 0;
858}
859
860static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba)
861{
862 switch (tl_hba->tl_proto_id) {
863 case SCSI_PROTOCOL_SAS:
864 return "SAS";
865 case SCSI_PROTOCOL_FCP:
866 return "FCP";
867 case SCSI_PROTOCOL_ISCSI:
868 return "iSCSI";
869 default:
870 break;
871 }
872
873 return "Unknown";
874}
875
876/* Start items for tcm_loop_port_cit */
877
878static int tcm_loop_port_link(
879 struct se_portal_group *se_tpg,
880 struct se_lun *lun)
881{
882 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
883 struct tcm_loop_tpg, tl_se_tpg);
884 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
885
886 atomic_inc(&tl_tpg->tl_tpg_port_count);
887 smp_mb__after_atomic_inc();
888 /*
889 * Add Linux/SCSI struct scsi_device by HCTL
890 */
891 scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun);
892
893 pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n");
894 return 0;
895}
896
897static void tcm_loop_port_unlink(
898 struct se_portal_group *se_tpg,
899 struct se_lun *se_lun)
900{
901 struct scsi_device *sd;
902 struct tcm_loop_hba *tl_hba;
903 struct tcm_loop_tpg *tl_tpg;
904
905 tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
906 tl_hba = tl_tpg->tl_hba;
907
908 sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt,
909 se_lun->unpacked_lun);
910 if (!sd) {
911 pr_err("Unable to locate struct scsi_device for %d:%d:"
912 "%d\n", 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun);
913 return;
914 }
915 /*
916 * Remove Linux/SCSI struct scsi_device by HCTL
917 */
918 scsi_remove_device(sd);
919 scsi_device_put(sd);
920
921 atomic_dec(&tl_tpg->tl_tpg_port_count);
922 smp_mb__after_atomic_dec();
923
924 pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n");
925}
926
927/* End items for tcm_loop_port_cit */
928
929/* Start items for tcm_loop_nexus_cit */
930
931static int tcm_loop_make_nexus(
932 struct tcm_loop_tpg *tl_tpg,
933 const char *name)
934{
935 struct se_portal_group *se_tpg;
936 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
937 struct tcm_loop_nexus *tl_nexus;
938 int ret = -ENOMEM;
939
940 if (tl_tpg->tl_hba->tl_nexus) {
941 pr_debug("tl_tpg->tl_hba->tl_nexus already exists\n");
942 return -EEXIST;
943 }
944 se_tpg = &tl_tpg->tl_se_tpg;
945
946 tl_nexus = kzalloc(sizeof(struct tcm_loop_nexus), GFP_KERNEL);
947 if (!tl_nexus) {
948 pr_err("Unable to allocate struct tcm_loop_nexus\n");
949 return -ENOMEM;
950 }
951 /*
952 * Initialize the struct se_session pointer
953 */
954 tl_nexus->se_sess = transport_init_session();
955 if (IS_ERR(tl_nexus->se_sess)) {
956 ret = PTR_ERR(tl_nexus->se_sess);
957 goto out;
958 }
959 /*
960 * Since we are running in 'demo mode' this call with generate a
961 * struct se_node_acl for the tcm_loop struct se_portal_group with the SCSI
962 * Initiator port name of the passed configfs group 'name'.
963 */
964 tl_nexus->se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
965 se_tpg, (unsigned char *)name);
966 if (!tl_nexus->se_sess->se_node_acl) {
967 transport_free_session(tl_nexus->se_sess);
968 goto out;
969 }
970 /*
971 * Now, register the SAS I_T Nexus as active with the call to
972 * transport_register_session()
973 */
974 __transport_register_session(se_tpg, tl_nexus->se_sess->se_node_acl,
975 tl_nexus->se_sess, tl_nexus);
976 tl_tpg->tl_hba->tl_nexus = tl_nexus;
977 pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated"
978 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
979 name);
980 return 0;
981
982out:
983 kfree(tl_nexus);
984 return ret;
985}
986
987static int tcm_loop_drop_nexus(
988 struct tcm_loop_tpg *tpg)
989{
990 struct se_session *se_sess;
991 struct tcm_loop_nexus *tl_nexus;
992 struct tcm_loop_hba *tl_hba = tpg->tl_hba;
993
994 tl_nexus = tpg->tl_hba->tl_nexus;
995 if (!tl_nexus)
996 return -ENODEV;
997
998 se_sess = tl_nexus->se_sess;
999 if (!se_sess)
1000 return -ENODEV;
1001
1002 if (atomic_read(&tpg->tl_tpg_port_count)) {
1003 pr_err("Unable to remove TCM_Loop I_T Nexus with"
1004 " active TPG port count: %d\n",
1005 atomic_read(&tpg->tl_tpg_port_count));
1006 return -EPERM;
1007 }
1008
1009 pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated"
1010 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
1011 tl_nexus->se_sess->se_node_acl->initiatorname);
1012 /*
1013 * Release the SCSI I_T Nexus to the emulated SAS Target Port
1014 */
1015 transport_deregister_session(tl_nexus->se_sess);
1016 tpg->tl_hba->tl_nexus = NULL;
1017 kfree(tl_nexus);
1018 return 0;
1019}
1020
1021/* End items for tcm_loop_nexus_cit */
1022
1023static ssize_t tcm_loop_tpg_show_nexus(
1024 struct se_portal_group *se_tpg,
1025 char *page)
1026{
1027 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1028 struct tcm_loop_tpg, tl_se_tpg);
1029 struct tcm_loop_nexus *tl_nexus;
1030 ssize_t ret;
1031
1032 tl_nexus = tl_tpg->tl_hba->tl_nexus;
1033 if (!tl_nexus)
1034 return -ENODEV;
1035
1036 ret = snprintf(page, PAGE_SIZE, "%s\n",
1037 tl_nexus->se_sess->se_node_acl->initiatorname);
1038
1039 return ret;
1040}
1041
1042static ssize_t tcm_loop_tpg_store_nexus(
1043 struct se_portal_group *se_tpg,
1044 const char *page,
1045 size_t count)
1046{
1047 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1048 struct tcm_loop_tpg, tl_se_tpg);
1049 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
1050 unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr;
1051 int ret;
1052 /*
1053 * Shutdown the active I_T nexus if 'NULL' is passed..
1054 */
1055 if (!strncmp(page, "NULL", 4)) {
1056 ret = tcm_loop_drop_nexus(tl_tpg);
1057 return (!ret) ? count : ret;
1058 }
1059 /*
1060 * Otherwise make sure the passed virtual Initiator port WWN matches
1061 * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call
1062 * tcm_loop_make_nexus()
1063 */
1064 if (strlen(page) >= TL_WWN_ADDR_LEN) {
1065 pr_err("Emulated NAA Sas Address: %s, exceeds"
1066 " max: %d\n", page, TL_WWN_ADDR_LEN);
1067 return -EINVAL;
1068 }
1069 snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page);
1070
1071 ptr = strstr(i_port, "naa.");
1072 if (ptr) {
1073 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) {
1074 pr_err("Passed SAS Initiator Port %s does not"
1075 " match target port protoid: %s\n", i_port,
1076 tcm_loop_dump_proto_id(tl_hba));
1077 return -EINVAL;
1078 }
1079 port_ptr = &i_port[0];
1080 goto check_newline;
1081 }
1082 ptr = strstr(i_port, "fc.");
1083 if (ptr) {
1084 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) {
1085 pr_err("Passed FCP Initiator Port %s does not"
1086 " match target port protoid: %s\n", i_port,
1087 tcm_loop_dump_proto_id(tl_hba));
1088 return -EINVAL;
1089 }
1090 port_ptr = &i_port[3]; /* Skip over "fc." */
1091 goto check_newline;
1092 }
1093 ptr = strstr(i_port, "iqn.");
1094 if (ptr) {
1095 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) {
1096 pr_err("Passed iSCSI Initiator Port %s does not"
1097 " match target port protoid: %s\n", i_port,
1098 tcm_loop_dump_proto_id(tl_hba));
1099 return -EINVAL;
1100 }
1101 port_ptr = &i_port[0];
1102 goto check_newline;
1103 }
1104 pr_err("Unable to locate prefix for emulated Initiator Port:"
1105 " %s\n", i_port);
1106 return -EINVAL;
1107 /*
1108 * Clear any trailing newline for the NAA WWN
1109 */
1110check_newline:
1111 if (i_port[strlen(i_port)-1] == '\n')
1112 i_port[strlen(i_port)-1] = '\0';
1113
1114 ret = tcm_loop_make_nexus(tl_tpg, port_ptr);
1115 if (ret < 0)
1116 return ret;
1117
1118 return count;
1119}
1120
1121TF_TPG_BASE_ATTR(tcm_loop, nexus, S_IRUGO | S_IWUSR);
1122
1123static struct configfs_attribute *tcm_loop_tpg_attrs[] = {
1124 &tcm_loop_tpg_nexus.attr,
1125 NULL,
1126};
1127
1128/* Start items for tcm_loop_naa_cit */
1129
1130struct se_portal_group *tcm_loop_make_naa_tpg(
1131 struct se_wwn *wwn,
1132 struct config_group *group,
1133 const char *name)
1134{
1135 struct tcm_loop_hba *tl_hba = container_of(wwn,
1136 struct tcm_loop_hba, tl_hba_wwn);
1137 struct tcm_loop_tpg *tl_tpg;
1138 char *tpgt_str, *end_ptr;
1139 int ret;
1140 unsigned short int tpgt;
1141
1142 tpgt_str = strstr(name, "tpgt_");
1143 if (!tpgt_str) {
1144 pr_err("Unable to locate \"tpgt_#\" directory"
1145 " group\n");
1146 return ERR_PTR(-EINVAL);
1147 }
1148 tpgt_str += 5; /* Skip ahead of "tpgt_" */
1149 tpgt = (unsigned short int) simple_strtoul(tpgt_str, &end_ptr, 0);
1150
1151 if (tpgt >= TL_TPGS_PER_HBA) {
1152 pr_err("Passed tpgt: %hu exceeds TL_TPGS_PER_HBA:"
1153 " %u\n", tpgt, TL_TPGS_PER_HBA);
1154 return ERR_PTR(-EINVAL);
1155 }
1156 tl_tpg = &tl_hba->tl_hba_tpgs[tpgt];
1157 tl_tpg->tl_hba = tl_hba;
1158 tl_tpg->tl_tpgt = tpgt;
1159 /*
1160 * Register the tl_tpg as a emulated SAS TCM Target Endpoint
1161 */
1162 ret = core_tpg_register(&tcm_loop_fabric_configfs->tf_ops,
1163 wwn, &tl_tpg->tl_se_tpg, tl_tpg,
1164 TRANSPORT_TPG_TYPE_NORMAL);
1165 if (ret < 0)
1166 return ERR_PTR(-ENOMEM);
1167
1168 pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s"
1169 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1170 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1171
1172 return &tl_tpg->tl_se_tpg;
1173}
1174
1175void tcm_loop_drop_naa_tpg(
1176 struct se_portal_group *se_tpg)
1177{
1178 struct se_wwn *wwn = se_tpg->se_tpg_wwn;
1179 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1180 struct tcm_loop_tpg, tl_se_tpg);
1181 struct tcm_loop_hba *tl_hba;
1182 unsigned short tpgt;
1183
1184 tl_hba = tl_tpg->tl_hba;
1185 tpgt = tl_tpg->tl_tpgt;
1186 /*
1187 * Release the I_T Nexus for the Virtual SAS link if present
1188 */
1189 tcm_loop_drop_nexus(tl_tpg);
1190 /*
1191 * Deregister the tl_tpg as a emulated SAS TCM Target Endpoint
1192 */
1193 core_tpg_deregister(se_tpg);
1194
1195 tl_tpg->tl_hba = NULL;
1196 tl_tpg->tl_tpgt = 0;
1197
1198 pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s"
1199 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1200 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1201}
1202
1203/* End items for tcm_loop_naa_cit */
1204
1205/* Start items for tcm_loop_cit */
1206
1207struct se_wwn *tcm_loop_make_scsi_hba(
1208 struct target_fabric_configfs *tf,
1209 struct config_group *group,
1210 const char *name)
1211{
1212 struct tcm_loop_hba *tl_hba;
1213 struct Scsi_Host *sh;
1214 char *ptr;
1215 int ret, off = 0;
1216
1217 tl_hba = kzalloc(sizeof(struct tcm_loop_hba), GFP_KERNEL);
1218 if (!tl_hba) {
1219 pr_err("Unable to allocate struct tcm_loop_hba\n");
1220 return ERR_PTR(-ENOMEM);
1221 }
1222 /*
1223 * Determine the emulated Protocol Identifier and Target Port Name
1224 * based on the incoming configfs directory name.
1225 */
1226 ptr = strstr(name, "naa.");
1227 if (ptr) {
1228 tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS;
1229 goto check_len;
1230 }
1231 ptr = strstr(name, "fc.");
1232 if (ptr) {
1233 tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP;
1234 off = 3; /* Skip over "fc." */
1235 goto check_len;
1236 }
1237 ptr = strstr(name, "iqn.");
1238 if (!ptr) {
1239 pr_err("Unable to locate prefix for emulated Target "
1240 "Port: %s\n", name);
1241 ret = -EINVAL;
1242 goto out;
1243 }
1244 tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI;
1245
1246check_len:
1247 if (strlen(name) >= TL_WWN_ADDR_LEN) {
1248 pr_err("Emulated NAA %s Address: %s, exceeds"
1249 " max: %d\n", name, tcm_loop_dump_proto_id(tl_hba),
1250 TL_WWN_ADDR_LEN);
1251 ret = -EINVAL;
1252 goto out;
1253 }
1254 snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]);
1255
1256 /*
1257 * Call device_register(tl_hba->dev) to register the emulated
1258 * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after
1259 * device_register() callbacks in tcm_loop_driver_probe()
1260 */
1261 ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt);
1262 if (ret)
1263 goto out;
1264
1265 sh = tl_hba->sh;
1266 tcm_loop_hba_no_cnt++;
1267 pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target"
1268 " %s Address: %s at Linux/SCSI Host ID: %d\n",
1269 tcm_loop_dump_proto_id(tl_hba), name, sh->host_no);
1270
1271 return &tl_hba->tl_hba_wwn;
1272out:
1273 kfree(tl_hba);
1274 return ERR_PTR(ret);
1275}
1276
1277void tcm_loop_drop_scsi_hba(
1278 struct se_wwn *wwn)
1279{
1280 struct tcm_loop_hba *tl_hba = container_of(wwn,
1281 struct tcm_loop_hba, tl_hba_wwn);
1282
1283 pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target"
1284 " SAS Address: %s at Linux/SCSI Host ID: %d\n",
1285 tl_hba->tl_wwn_address, tl_hba->sh->host_no);
1286 /*
1287 * Call device_unregister() on the original tl_hba->dev.
1288 * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will
1289 * release *tl_hba;
1290 */
1291 device_unregister(&tl_hba->dev);
1292}
1293
1294/* Start items for tcm_loop_cit */
1295static ssize_t tcm_loop_wwn_show_attr_version(
1296 struct target_fabric_configfs *tf,
1297 char *page)
1298{
1299 return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION);
1300}
1301
1302TF_WWN_ATTR_RO(tcm_loop, version);
1303
1304static struct configfs_attribute *tcm_loop_wwn_attrs[] = {
1305 &tcm_loop_wwn_version.attr,
1306 NULL,
1307};
1308
1309/* End items for tcm_loop_cit */
1310
1311static int tcm_loop_register_configfs(void)
1312{
1313 struct target_fabric_configfs *fabric;
1314 int ret;
1315 /*
1316 * Set the TCM Loop HBA counter to zero
1317 */
1318 tcm_loop_hba_no_cnt = 0;
1319 /*
1320 * Register the top level struct config_item_type with TCM core
1321 */
1322 fabric = target_fabric_configfs_init(THIS_MODULE, "loopback");
1323 if (IS_ERR(fabric)) {
1324 pr_err("tcm_loop_register_configfs() failed!\n");
1325 return PTR_ERR(fabric);
1326 }
1327 /*
1328 * Setup the fabric API of function pointers used by target_core_mod
1329 */
1330 fabric->tf_ops.get_fabric_name = &tcm_loop_get_fabric_name;
1331 fabric->tf_ops.get_fabric_proto_ident = &tcm_loop_get_fabric_proto_ident;
1332 fabric->tf_ops.tpg_get_wwn = &tcm_loop_get_endpoint_wwn;
1333 fabric->tf_ops.tpg_get_tag = &tcm_loop_get_tag;
1334 fabric->tf_ops.tpg_get_default_depth = &tcm_loop_get_default_depth;
1335 fabric->tf_ops.tpg_get_pr_transport_id = &tcm_loop_get_pr_transport_id;
1336 fabric->tf_ops.tpg_get_pr_transport_id_len =
1337 &tcm_loop_get_pr_transport_id_len;
1338 fabric->tf_ops.tpg_parse_pr_out_transport_id =
1339 &tcm_loop_parse_pr_out_transport_id;
1340 fabric->tf_ops.tpg_check_demo_mode = &tcm_loop_check_demo_mode;
1341 fabric->tf_ops.tpg_check_demo_mode_cache =
1342 &tcm_loop_check_demo_mode_cache;
1343 fabric->tf_ops.tpg_check_demo_mode_write_protect =
1344 &tcm_loop_check_demo_mode_write_protect;
1345 fabric->tf_ops.tpg_check_prod_mode_write_protect =
1346 &tcm_loop_check_prod_mode_write_protect;
1347 /*
1348 * The TCM loopback fabric module runs in demo-mode to a local
1349 * virtual SCSI device, so fabric dependent initator ACLs are
1350 * not required.
1351 */
1352 fabric->tf_ops.tpg_alloc_fabric_acl = &tcm_loop_tpg_alloc_fabric_acl;
1353 fabric->tf_ops.tpg_release_fabric_acl =
1354 &tcm_loop_tpg_release_fabric_acl;
1355 fabric->tf_ops.tpg_get_inst_index = &tcm_loop_get_inst_index;
1356 /*
1357 * Used for setting up remaining TCM resources in process context
1358 */
1359 fabric->tf_ops.check_stop_free = &tcm_loop_check_stop_free;
1360 fabric->tf_ops.release_cmd = &tcm_loop_release_cmd;
1361 fabric->tf_ops.shutdown_session = &tcm_loop_shutdown_session;
1362 fabric->tf_ops.close_session = &tcm_loop_close_session;
1363 fabric->tf_ops.sess_get_index = &tcm_loop_sess_get_index;
1364 fabric->tf_ops.sess_get_initiator_sid = NULL;
1365 fabric->tf_ops.write_pending = &tcm_loop_write_pending;
1366 fabric->tf_ops.write_pending_status = &tcm_loop_write_pending_status;
1367 /*
1368 * Not used for TCM loopback
1369 */
1370 fabric->tf_ops.set_default_node_attributes =
1371 &tcm_loop_set_default_node_attributes;
1372 fabric->tf_ops.get_task_tag = &tcm_loop_get_task_tag;
1373 fabric->tf_ops.get_cmd_state = &tcm_loop_get_cmd_state;
1374 fabric->tf_ops.queue_data_in = &tcm_loop_queue_data_in;
1375 fabric->tf_ops.queue_status = &tcm_loop_queue_status;
1376 fabric->tf_ops.queue_tm_rsp = &tcm_loop_queue_tm_rsp;
1377 fabric->tf_ops.set_fabric_sense_len = &tcm_loop_set_fabric_sense_len;
1378 fabric->tf_ops.get_fabric_sense_len = &tcm_loop_get_fabric_sense_len;
1379
1380 /*
1381 * Setup function pointers for generic logic in target_core_fabric_configfs.c
1382 */
1383 fabric->tf_ops.fabric_make_wwn = &tcm_loop_make_scsi_hba;
1384 fabric->tf_ops.fabric_drop_wwn = &tcm_loop_drop_scsi_hba;
1385 fabric->tf_ops.fabric_make_tpg = &tcm_loop_make_naa_tpg;
1386 fabric->tf_ops.fabric_drop_tpg = &tcm_loop_drop_naa_tpg;
1387 /*
1388 * fabric_post_link() and fabric_pre_unlink() are used for
1389 * registration and release of TCM Loop Virtual SCSI LUNs.
1390 */
1391 fabric->tf_ops.fabric_post_link = &tcm_loop_port_link;
1392 fabric->tf_ops.fabric_pre_unlink = &tcm_loop_port_unlink;
1393 fabric->tf_ops.fabric_make_np = NULL;
1394 fabric->tf_ops.fabric_drop_np = NULL;
1395 /*
1396 * Setup default attribute lists for various fabric->tf_cit_tmpl
1397 */
1398 TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = tcm_loop_wwn_attrs;
1399 TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = tcm_loop_tpg_attrs;
1400 TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
1401 TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
1402 TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
1403 /*
1404 * Once fabric->tf_ops has been setup, now register the fabric for
1405 * use within TCM
1406 */
1407 ret = target_fabric_configfs_register(fabric);
1408 if (ret < 0) {
1409 pr_err("target_fabric_configfs_register() for"
1410 " TCM_Loop failed!\n");
1411 target_fabric_configfs_free(fabric);
1412 return -1;
1413 }
1414 /*
1415 * Setup our local pointer to *fabric.
1416 */
1417 tcm_loop_fabric_configfs = fabric;
1418 pr_debug("TCM_LOOP[0] - Set fabric ->"
1419 " tcm_loop_fabric_configfs\n");
1420 return 0;
1421}
1422
1423static void tcm_loop_deregister_configfs(void)
1424{
1425 if (!tcm_loop_fabric_configfs)
1426 return;
1427
1428 target_fabric_configfs_deregister(tcm_loop_fabric_configfs);
1429 tcm_loop_fabric_configfs = NULL;
1430 pr_debug("TCM_LOOP[0] - Cleared"
1431 " tcm_loop_fabric_configfs\n");
1432}
1433
1434static int __init tcm_loop_fabric_init(void)
1435{
1436 int ret = -ENOMEM;
1437
1438 tcm_loop_workqueue = alloc_workqueue("tcm_loop", 0, 0);
1439 if (!tcm_loop_workqueue)
1440 goto out;
1441
1442 tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache",
1443 sizeof(struct tcm_loop_cmd),
1444 __alignof__(struct tcm_loop_cmd),
1445 0, NULL);
1446 if (!tcm_loop_cmd_cache) {
1447 pr_debug("kmem_cache_create() for"
1448 " tcm_loop_cmd_cache failed\n");
1449 goto out_destroy_workqueue;
1450 }
1451
1452 ret = tcm_loop_alloc_core_bus();
1453 if (ret)
1454 goto out_destroy_cache;
1455
1456 ret = tcm_loop_register_configfs();
1457 if (ret)
1458 goto out_release_core_bus;
1459
1460 return 0;
1461
1462out_release_core_bus:
1463 tcm_loop_release_core_bus();
1464out_destroy_cache:
1465 kmem_cache_destroy(tcm_loop_cmd_cache);
1466out_destroy_workqueue:
1467 destroy_workqueue(tcm_loop_workqueue);
1468out:
1469 return ret;
1470}
1471
1472static void __exit tcm_loop_fabric_exit(void)
1473{
1474 tcm_loop_deregister_configfs();
1475 tcm_loop_release_core_bus();
1476 kmem_cache_destroy(tcm_loop_cmd_cache);
1477 destroy_workqueue(tcm_loop_workqueue);
1478}
1479
1480MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module");
1481MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>");
1482MODULE_LICENSE("GPL");
1483module_init(tcm_loop_fabric_init);
1484module_exit(tcm_loop_fabric_exit);