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