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 42 static struct workqueue_struct *tcm_loop_workqueue; 43 static struct kmem_cache *tcm_loop_cmd_cache; 44 45 static int tcm_loop_hba_no_cnt; 46 47 static int tcm_loop_queue_status(struct se_cmd *se_cmd); 48 49 /* 50 * Called from struct target_core_fabric_ops->check_stop_free() 51 */ 52 static int tcm_loop_check_stop_free(struct se_cmd *se_cmd) 53 { 54 return transport_generic_free_cmd(se_cmd, 0); 55 } 56 57 static 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 65 static 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 71 static int tcm_loop_driver_probe(struct device *); 72 static int tcm_loop_driver_remove(struct device *); 73 74 static int pseudo_lld_bus_match(struct device *dev, 75 struct device_driver *dev_driver) 76 { 77 return 1; 78 } 79 80 static struct bus_type tcm_loop_lld_bus = { 81 .name = "tcm_loop_bus", 82 .match = pseudo_lld_bus_match, 83 .probe = tcm_loop_driver_probe, 84 .remove = tcm_loop_driver_remove, 85 }; 86 87 static 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 */ 94 static struct device *tcm_loop_primary; 95 96 static 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 if (scsi_bidi_cmnd(sc)) { 132 struct scsi_data_buffer *sdb = scsi_in(sc); 133 134 sgl_bidi = sdb->table.sgl; 135 sgl_bidi_count = sdb->table.nents; 136 se_cmd->se_cmd_flags |= SCF_BIDI; 137 138 } 139 140 transfer_length = scsi_transfer_length(sc); 141 if (!scsi_prot_sg_count(sc) && 142 scsi_get_prot_op(sc) != SCSI_PROT_NORMAL) { 143 se_cmd->prot_pto = true; 144 /* 145 * loopback transport doesn't support 146 * WRITE_GENERATE, READ_STRIP protection 147 * information operations, go ahead unprotected. 148 */ 149 transfer_length = scsi_bufflen(sc); 150 } 151 152 se_cmd->tag = tl_cmd->sc_cmd_tag; 153 rc = target_submit_cmd_map_sgls(se_cmd, tl_nexus->se_sess, sc->cmnd, 154 &tl_cmd->tl_sense_buf[0], tl_cmd->sc->device->lun, 155 transfer_length, TCM_SIMPLE_TAG, 156 sc->sc_data_direction, 0, 157 scsi_sglist(sc), scsi_sg_count(sc), 158 sgl_bidi, sgl_bidi_count, 159 scsi_prot_sglist(sc), scsi_prot_sg_count(sc)); 160 if (rc < 0) { 161 set_host_byte(sc, DID_NO_CONNECT); 162 goto out_done; 163 } 164 return; 165 166 out_done: 167 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd); 168 sc->scsi_done(sc); 169 } 170 171 /* 172 * ->queuecommand can be and usually is called from interrupt context, so 173 * defer the actual submission to a workqueue. 174 */ 175 static int tcm_loop_queuecommand(struct Scsi_Host *sh, struct scsi_cmnd *sc) 176 { 177 struct tcm_loop_cmd *tl_cmd; 178 179 pr_debug("%s() %d:%d:%d:%llu got CDB: 0x%02x scsi_buf_len: %u\n", 180 __func__, sc->device->host->host_no, sc->device->id, 181 sc->device->channel, sc->device->lun, sc->cmnd[0], 182 scsi_bufflen(sc)); 183 184 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC); 185 if (!tl_cmd) { 186 set_host_byte(sc, DID_ERROR); 187 sc->scsi_done(sc); 188 return 0; 189 } 190 191 tl_cmd->sc = sc; 192 tl_cmd->sc_cmd_tag = sc->request->tag; 193 INIT_WORK(&tl_cmd->work, tcm_loop_submission_work); 194 queue_work(tcm_loop_workqueue, &tl_cmd->work); 195 return 0; 196 } 197 198 /* 199 * Called from SCSI EH process context to issue a LUN_RESET TMR 200 * to struct scsi_device 201 */ 202 static int tcm_loop_issue_tmr(struct tcm_loop_tpg *tl_tpg, 203 u64 lun, int task, enum tcm_tmreq_table tmr) 204 { 205 struct se_cmd *se_cmd; 206 struct se_session *se_sess; 207 struct tcm_loop_nexus *tl_nexus; 208 struct tcm_loop_cmd *tl_cmd; 209 int ret = TMR_FUNCTION_FAILED, rc; 210 211 /* 212 * Locate the tl_nexus and se_sess pointers 213 */ 214 tl_nexus = tl_tpg->tl_nexus; 215 if (!tl_nexus) { 216 pr_err("Unable to perform device reset without active I_T Nexus\n"); 217 return ret; 218 } 219 220 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL); 221 if (!tl_cmd) 222 return ret; 223 224 init_completion(&tl_cmd->tmr_done); 225 226 se_cmd = &tl_cmd->tl_se_cmd; 227 se_sess = tl_tpg->tl_nexus->se_sess; 228 229 rc = target_submit_tmr(se_cmd, se_sess, tl_cmd->tl_sense_buf, lun, 230 NULL, tmr, GFP_KERNEL, task, 231 TARGET_SCF_ACK_KREF); 232 if (rc < 0) 233 goto release; 234 wait_for_completion(&tl_cmd->tmr_done); 235 ret = se_cmd->se_tmr_req->response; 236 target_put_sess_cmd(se_cmd); 237 238 out: 239 return ret; 240 241 release: 242 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd); 243 goto out; 244 } 245 246 static int tcm_loop_abort_task(struct scsi_cmnd *sc) 247 { 248 struct tcm_loop_hba *tl_hba; 249 struct tcm_loop_tpg *tl_tpg; 250 int ret = FAILED; 251 252 /* 253 * Locate the tcm_loop_hba_t pointer 254 */ 255 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host); 256 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id]; 257 ret = tcm_loop_issue_tmr(tl_tpg, sc->device->lun, 258 sc->request->tag, TMR_ABORT_TASK); 259 return (ret == TMR_FUNCTION_COMPLETE) ? SUCCESS : FAILED; 260 } 261 262 /* 263 * Called from SCSI EH process context to issue a LUN_RESET TMR 264 * to struct scsi_device 265 */ 266 static int tcm_loop_device_reset(struct scsi_cmnd *sc) 267 { 268 struct tcm_loop_hba *tl_hba; 269 struct tcm_loop_tpg *tl_tpg; 270 int ret = FAILED; 271 272 /* 273 * Locate the tcm_loop_hba_t pointer 274 */ 275 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host); 276 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id]; 277 278 ret = tcm_loop_issue_tmr(tl_tpg, sc->device->lun, 279 0, TMR_LUN_RESET); 280 return (ret == TMR_FUNCTION_COMPLETE) ? SUCCESS : FAILED; 281 } 282 283 static int tcm_loop_target_reset(struct scsi_cmnd *sc) 284 { 285 struct tcm_loop_hba *tl_hba; 286 struct tcm_loop_tpg *tl_tpg; 287 288 /* 289 * Locate the tcm_loop_hba_t pointer 290 */ 291 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host); 292 if (!tl_hba) { 293 pr_err("Unable to perform device reset without active I_T Nexus\n"); 294 return FAILED; 295 } 296 /* 297 * Locate the tl_tpg pointer from TargetID in sc->device->id 298 */ 299 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id]; 300 if (tl_tpg) { 301 tl_tpg->tl_transport_status = TCM_TRANSPORT_ONLINE; 302 return SUCCESS; 303 } 304 return FAILED; 305 } 306 307 static int tcm_loop_slave_alloc(struct scsi_device *sd) 308 { 309 blk_queue_flag_set(QUEUE_FLAG_BIDI, sd->request_queue); 310 return 0; 311 } 312 313 static struct scsi_host_template tcm_loop_driver_template = { 314 .show_info = tcm_loop_show_info, 315 .proc_name = "tcm_loopback", 316 .name = "TCM_Loopback", 317 .queuecommand = tcm_loop_queuecommand, 318 .change_queue_depth = scsi_change_queue_depth, 319 .eh_abort_handler = tcm_loop_abort_task, 320 .eh_device_reset_handler = tcm_loop_device_reset, 321 .eh_target_reset_handler = tcm_loop_target_reset, 322 .can_queue = 1024, 323 .this_id = -1, 324 .sg_tablesize = 256, 325 .cmd_per_lun = 1024, 326 .max_sectors = 0xFFFF, 327 .dma_boundary = PAGE_SIZE - 1, 328 .slave_alloc = tcm_loop_slave_alloc, 329 .module = THIS_MODULE, 330 .track_queue_depth = 1, 331 }; 332 333 static int tcm_loop_driver_probe(struct device *dev) 334 { 335 struct tcm_loop_hba *tl_hba; 336 struct Scsi_Host *sh; 337 int error, host_prot; 338 339 tl_hba = to_tcm_loop_hba(dev); 340 341 sh = scsi_host_alloc(&tcm_loop_driver_template, 342 sizeof(struct tcm_loop_hba)); 343 if (!sh) { 344 pr_err("Unable to allocate struct scsi_host\n"); 345 return -ENODEV; 346 } 347 tl_hba->sh = sh; 348 349 /* 350 * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata 351 */ 352 *((struct tcm_loop_hba **)sh->hostdata) = tl_hba; 353 /* 354 * Setup single ID, Channel and LUN for now.. 355 */ 356 sh->max_id = 2; 357 sh->max_lun = 0; 358 sh->max_channel = 0; 359 sh->max_cmd_len = SCSI_MAX_VARLEN_CDB_SIZE; 360 361 host_prot = SHOST_DIF_TYPE1_PROTECTION | SHOST_DIF_TYPE2_PROTECTION | 362 SHOST_DIF_TYPE3_PROTECTION | SHOST_DIX_TYPE1_PROTECTION | 363 SHOST_DIX_TYPE2_PROTECTION | SHOST_DIX_TYPE3_PROTECTION; 364 365 scsi_host_set_prot(sh, host_prot); 366 scsi_host_set_guard(sh, SHOST_DIX_GUARD_CRC); 367 368 error = scsi_add_host(sh, &tl_hba->dev); 369 if (error) { 370 pr_err("%s: scsi_add_host failed\n", __func__); 371 scsi_host_put(sh); 372 return -ENODEV; 373 } 374 return 0; 375 } 376 377 static int tcm_loop_driver_remove(struct device *dev) 378 { 379 struct tcm_loop_hba *tl_hba; 380 struct Scsi_Host *sh; 381 382 tl_hba = to_tcm_loop_hba(dev); 383 sh = tl_hba->sh; 384 385 scsi_remove_host(sh); 386 scsi_host_put(sh); 387 return 0; 388 } 389 390 static void tcm_loop_release_adapter(struct device *dev) 391 { 392 struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev); 393 394 kfree(tl_hba); 395 } 396 397 /* 398 * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c 399 */ 400 static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id) 401 { 402 int ret; 403 404 tl_hba->dev.bus = &tcm_loop_lld_bus; 405 tl_hba->dev.parent = tcm_loop_primary; 406 tl_hba->dev.release = &tcm_loop_release_adapter; 407 dev_set_name(&tl_hba->dev, "tcm_loop_adapter_%d", tcm_loop_host_id); 408 409 ret = device_register(&tl_hba->dev); 410 if (ret) { 411 pr_err("device_register() failed for tl_hba->dev: %d\n", ret); 412 return -ENODEV; 413 } 414 415 return 0; 416 } 417 418 /* 419 * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated 420 * tcm_loop SCSI bus. 421 */ 422 static int tcm_loop_alloc_core_bus(void) 423 { 424 int ret; 425 426 tcm_loop_primary = root_device_register("tcm_loop_0"); 427 if (IS_ERR(tcm_loop_primary)) { 428 pr_err("Unable to allocate tcm_loop_primary\n"); 429 return PTR_ERR(tcm_loop_primary); 430 } 431 432 ret = bus_register(&tcm_loop_lld_bus); 433 if (ret) { 434 pr_err("bus_register() failed for tcm_loop_lld_bus\n"); 435 goto dev_unreg; 436 } 437 438 ret = driver_register(&tcm_loop_driverfs); 439 if (ret) { 440 pr_err("driver_register() failed for tcm_loop_driverfs\n"); 441 goto bus_unreg; 442 } 443 444 pr_debug("Initialized TCM Loop Core Bus\n"); 445 return ret; 446 447 bus_unreg: 448 bus_unregister(&tcm_loop_lld_bus); 449 dev_unreg: 450 root_device_unregister(tcm_loop_primary); 451 return ret; 452 } 453 454 static void tcm_loop_release_core_bus(void) 455 { 456 driver_unregister(&tcm_loop_driverfs); 457 bus_unregister(&tcm_loop_lld_bus); 458 root_device_unregister(tcm_loop_primary); 459 460 pr_debug("Releasing TCM Loop Core BUS\n"); 461 } 462 463 static inline struct tcm_loop_tpg *tl_tpg(struct se_portal_group *se_tpg) 464 { 465 return container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg); 466 } 467 468 static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg) 469 { 470 /* 471 * Return the passed NAA identifier for the Target Port 472 */ 473 return &tl_tpg(se_tpg)->tl_hba->tl_wwn_address[0]; 474 } 475 476 static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg) 477 { 478 /* 479 * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83 480 * to represent the SCSI Target Port. 481 */ 482 return tl_tpg(se_tpg)->tl_tpgt; 483 } 484 485 /* 486 * Returning (1) here allows for target_core_mod struct se_node_acl to be generated 487 * based upon the incoming fabric dependent SCSI Initiator Port 488 */ 489 static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg) 490 { 491 return 1; 492 } 493 494 static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg) 495 { 496 return 0; 497 } 498 499 /* 500 * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for 501 * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest 502 */ 503 static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg) 504 { 505 return 0; 506 } 507 508 /* 509 * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will 510 * never be called for TCM_Loop by target_core_fabric_configfs.c code. 511 * It has been added here as a nop for target_fabric_tf_ops_check() 512 */ 513 static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg) 514 { 515 return 0; 516 } 517 518 static int tcm_loop_check_prot_fabric_only(struct se_portal_group *se_tpg) 519 { 520 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, 521 tl_se_tpg); 522 return tl_tpg->tl_fabric_prot_type; 523 } 524 525 static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg) 526 { 527 return 1; 528 } 529 530 static u32 tcm_loop_sess_get_index(struct se_session *se_sess) 531 { 532 return 1; 533 } 534 535 static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl) 536 { 537 return; 538 } 539 540 static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd) 541 { 542 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd, 543 struct tcm_loop_cmd, tl_se_cmd); 544 545 return tl_cmd->sc_cmd_state; 546 } 547 548 static int tcm_loop_write_pending(struct se_cmd *se_cmd) 549 { 550 /* 551 * Since Linux/SCSI has already sent down a struct scsi_cmnd 552 * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array 553 * memory, and memory has already been mapped to struct se_cmd->t_mem_list 554 * format with transport_generic_map_mem_to_cmd(). 555 * 556 * We now tell TCM to add this WRITE CDB directly into the TCM storage 557 * object execution queue. 558 */ 559 target_execute_cmd(se_cmd); 560 return 0; 561 } 562 563 static int tcm_loop_queue_data_in(struct se_cmd *se_cmd) 564 { 565 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd, 566 struct tcm_loop_cmd, tl_se_cmd); 567 struct scsi_cmnd *sc = tl_cmd->sc; 568 569 pr_debug("%s() called for scsi_cmnd: %p cdb: 0x%02x\n", 570 __func__, sc, sc->cmnd[0]); 571 572 sc->result = SAM_STAT_GOOD; 573 set_host_byte(sc, DID_OK); 574 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) || 575 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT)) 576 scsi_set_resid(sc, se_cmd->residual_count); 577 sc->scsi_done(sc); 578 return 0; 579 } 580 581 static int tcm_loop_queue_status(struct se_cmd *se_cmd) 582 { 583 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd, 584 struct tcm_loop_cmd, tl_se_cmd); 585 struct scsi_cmnd *sc = tl_cmd->sc; 586 587 pr_debug("%s() called for scsi_cmnd: %p cdb: 0x%02x\n", 588 __func__, sc, sc->cmnd[0]); 589 590 if (se_cmd->sense_buffer && 591 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) || 592 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) { 593 594 memcpy(sc->sense_buffer, se_cmd->sense_buffer, 595 SCSI_SENSE_BUFFERSIZE); 596 sc->result = SAM_STAT_CHECK_CONDITION; 597 set_driver_byte(sc, DRIVER_SENSE); 598 } else 599 sc->result = se_cmd->scsi_status; 600 601 set_host_byte(sc, DID_OK); 602 if ((se_cmd->se_cmd_flags & SCF_OVERFLOW_BIT) || 603 (se_cmd->se_cmd_flags & SCF_UNDERFLOW_BIT)) 604 scsi_set_resid(sc, se_cmd->residual_count); 605 sc->scsi_done(sc); 606 return 0; 607 } 608 609 static void tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd) 610 { 611 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd, 612 struct tcm_loop_cmd, tl_se_cmd); 613 614 /* Wake up tcm_loop_issue_tmr(). */ 615 complete(&tl_cmd->tmr_done); 616 } 617 618 static void tcm_loop_aborted_task(struct se_cmd *se_cmd) 619 { 620 return; 621 } 622 623 static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba) 624 { 625 switch (tl_hba->tl_proto_id) { 626 case SCSI_PROTOCOL_SAS: 627 return "SAS"; 628 case SCSI_PROTOCOL_FCP: 629 return "FCP"; 630 case SCSI_PROTOCOL_ISCSI: 631 return "iSCSI"; 632 default: 633 break; 634 } 635 636 return "Unknown"; 637 } 638 639 /* Start items for tcm_loop_port_cit */ 640 641 static int tcm_loop_port_link( 642 struct se_portal_group *se_tpg, 643 struct se_lun *lun) 644 { 645 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 646 struct tcm_loop_tpg, tl_se_tpg); 647 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba; 648 649 atomic_inc_mb(&tl_tpg->tl_tpg_port_count); 650 /* 651 * Add Linux/SCSI struct scsi_device by HCTL 652 */ 653 scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun); 654 655 pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n"); 656 return 0; 657 } 658 659 static void tcm_loop_port_unlink( 660 struct se_portal_group *se_tpg, 661 struct se_lun *se_lun) 662 { 663 struct scsi_device *sd; 664 struct tcm_loop_hba *tl_hba; 665 struct tcm_loop_tpg *tl_tpg; 666 667 tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg); 668 tl_hba = tl_tpg->tl_hba; 669 670 sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt, 671 se_lun->unpacked_lun); 672 if (!sd) { 673 pr_err("Unable to locate struct scsi_device for %d:%d:%llu\n", 674 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun); 675 return; 676 } 677 /* 678 * Remove Linux/SCSI struct scsi_device by HCTL 679 */ 680 scsi_remove_device(sd); 681 scsi_device_put(sd); 682 683 atomic_dec_mb(&tl_tpg->tl_tpg_port_count); 684 685 pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n"); 686 } 687 688 /* End items for tcm_loop_port_cit */ 689 690 static ssize_t tcm_loop_tpg_attrib_fabric_prot_type_show( 691 struct config_item *item, char *page) 692 { 693 struct se_portal_group *se_tpg = attrib_to_tpg(item); 694 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, 695 tl_se_tpg); 696 697 return sprintf(page, "%d\n", tl_tpg->tl_fabric_prot_type); 698 } 699 700 static ssize_t tcm_loop_tpg_attrib_fabric_prot_type_store( 701 struct config_item *item, const char *page, size_t count) 702 { 703 struct se_portal_group *se_tpg = attrib_to_tpg(item); 704 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, 705 tl_se_tpg); 706 unsigned long val; 707 int ret = kstrtoul(page, 0, &val); 708 709 if (ret) { 710 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret); 711 return ret; 712 } 713 if (val != 0 && val != 1 && val != 3) { 714 pr_err("Invalid qla2xxx fabric_prot_type: %lu\n", val); 715 return -EINVAL; 716 } 717 tl_tpg->tl_fabric_prot_type = val; 718 719 return count; 720 } 721 722 CONFIGFS_ATTR(tcm_loop_tpg_attrib_, fabric_prot_type); 723 724 static struct configfs_attribute *tcm_loop_tpg_attrib_attrs[] = { 725 &tcm_loop_tpg_attrib_attr_fabric_prot_type, 726 NULL, 727 }; 728 729 /* Start items for tcm_loop_nexus_cit */ 730 731 static int tcm_loop_alloc_sess_cb(struct se_portal_group *se_tpg, 732 struct se_session *se_sess, void *p) 733 { 734 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 735 struct tcm_loop_tpg, tl_se_tpg); 736 737 tl_tpg->tl_nexus = p; 738 return 0; 739 } 740 741 static int tcm_loop_make_nexus( 742 struct tcm_loop_tpg *tl_tpg, 743 const char *name) 744 { 745 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba; 746 struct tcm_loop_nexus *tl_nexus; 747 int ret; 748 749 if (tl_tpg->tl_nexus) { 750 pr_debug("tl_tpg->tl_nexus already exists\n"); 751 return -EEXIST; 752 } 753 754 tl_nexus = kzalloc(sizeof(*tl_nexus), GFP_KERNEL); 755 if (!tl_nexus) 756 return -ENOMEM; 757 758 tl_nexus->se_sess = target_setup_session(&tl_tpg->tl_se_tpg, 0, 0, 759 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS, 760 name, tl_nexus, tcm_loop_alloc_sess_cb); 761 if (IS_ERR(tl_nexus->se_sess)) { 762 ret = PTR_ERR(tl_nexus->se_sess); 763 kfree(tl_nexus); 764 return ret; 765 } 766 767 pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated %s Initiator Port: %s\n", 768 tcm_loop_dump_proto_id(tl_hba), name); 769 return 0; 770 } 771 772 static int tcm_loop_drop_nexus( 773 struct tcm_loop_tpg *tpg) 774 { 775 struct se_session *se_sess; 776 struct tcm_loop_nexus *tl_nexus; 777 778 tl_nexus = tpg->tl_nexus; 779 if (!tl_nexus) 780 return -ENODEV; 781 782 se_sess = tl_nexus->se_sess; 783 if (!se_sess) 784 return -ENODEV; 785 786 if (atomic_read(&tpg->tl_tpg_port_count)) { 787 pr_err("Unable to remove TCM_Loop I_T Nexus with active TPG port count: %d\n", 788 atomic_read(&tpg->tl_tpg_port_count)); 789 return -EPERM; 790 } 791 792 pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated %s Initiator Port: %s\n", 793 tcm_loop_dump_proto_id(tpg->tl_hba), 794 tl_nexus->se_sess->se_node_acl->initiatorname); 795 /* 796 * Release the SCSI I_T Nexus to the emulated Target Port 797 */ 798 target_remove_session(se_sess); 799 tpg->tl_nexus = NULL; 800 kfree(tl_nexus); 801 return 0; 802 } 803 804 /* End items for tcm_loop_nexus_cit */ 805 806 static ssize_t tcm_loop_tpg_nexus_show(struct config_item *item, char *page) 807 { 808 struct se_portal_group *se_tpg = to_tpg(item); 809 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 810 struct tcm_loop_tpg, tl_se_tpg); 811 struct tcm_loop_nexus *tl_nexus; 812 ssize_t ret; 813 814 tl_nexus = tl_tpg->tl_nexus; 815 if (!tl_nexus) 816 return -ENODEV; 817 818 ret = snprintf(page, PAGE_SIZE, "%s\n", 819 tl_nexus->se_sess->se_node_acl->initiatorname); 820 821 return ret; 822 } 823 824 static ssize_t tcm_loop_tpg_nexus_store(struct config_item *item, 825 const char *page, size_t count) 826 { 827 struct se_portal_group *se_tpg = to_tpg(item); 828 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 829 struct tcm_loop_tpg, tl_se_tpg); 830 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba; 831 unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr; 832 int ret; 833 /* 834 * Shutdown the active I_T nexus if 'NULL' is passed.. 835 */ 836 if (!strncmp(page, "NULL", 4)) { 837 ret = tcm_loop_drop_nexus(tl_tpg); 838 return (!ret) ? count : ret; 839 } 840 /* 841 * Otherwise make sure the passed virtual Initiator port WWN matches 842 * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call 843 * tcm_loop_make_nexus() 844 */ 845 if (strlen(page) >= TL_WWN_ADDR_LEN) { 846 pr_err("Emulated NAA Sas Address: %s, exceeds max: %d\n", 847 page, TL_WWN_ADDR_LEN); 848 return -EINVAL; 849 } 850 snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page); 851 852 ptr = strstr(i_port, "naa."); 853 if (ptr) { 854 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) { 855 pr_err("Passed SAS Initiator Port %s does not match target port protoid: %s\n", 856 i_port, tcm_loop_dump_proto_id(tl_hba)); 857 return -EINVAL; 858 } 859 port_ptr = &i_port[0]; 860 goto check_newline; 861 } 862 ptr = strstr(i_port, "fc."); 863 if (ptr) { 864 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) { 865 pr_err("Passed FCP Initiator Port %s does not match target port protoid: %s\n", 866 i_port, tcm_loop_dump_proto_id(tl_hba)); 867 return -EINVAL; 868 } 869 port_ptr = &i_port[3]; /* Skip over "fc." */ 870 goto check_newline; 871 } 872 ptr = strstr(i_port, "iqn."); 873 if (ptr) { 874 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) { 875 pr_err("Passed iSCSI Initiator Port %s does not match target port protoid: %s\n", 876 i_port, tcm_loop_dump_proto_id(tl_hba)); 877 return -EINVAL; 878 } 879 port_ptr = &i_port[0]; 880 goto check_newline; 881 } 882 pr_err("Unable to locate prefix for emulated Initiator Port: %s\n", 883 i_port); 884 return -EINVAL; 885 /* 886 * Clear any trailing newline for the NAA WWN 887 */ 888 check_newline: 889 if (i_port[strlen(i_port)-1] == '\n') 890 i_port[strlen(i_port)-1] = '\0'; 891 892 ret = tcm_loop_make_nexus(tl_tpg, port_ptr); 893 if (ret < 0) 894 return ret; 895 896 return count; 897 } 898 899 static ssize_t tcm_loop_tpg_transport_status_show(struct config_item *item, 900 char *page) 901 { 902 struct se_portal_group *se_tpg = to_tpg(item); 903 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 904 struct tcm_loop_tpg, tl_se_tpg); 905 const char *status = NULL; 906 ssize_t ret = -EINVAL; 907 908 switch (tl_tpg->tl_transport_status) { 909 case TCM_TRANSPORT_ONLINE: 910 status = "online"; 911 break; 912 case TCM_TRANSPORT_OFFLINE: 913 status = "offline"; 914 break; 915 default: 916 break; 917 } 918 919 if (status) 920 ret = snprintf(page, PAGE_SIZE, "%s\n", status); 921 922 return ret; 923 } 924 925 static ssize_t tcm_loop_tpg_transport_status_store(struct config_item *item, 926 const char *page, size_t count) 927 { 928 struct se_portal_group *se_tpg = to_tpg(item); 929 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 930 struct tcm_loop_tpg, tl_se_tpg); 931 932 if (!strncmp(page, "online", 6)) { 933 tl_tpg->tl_transport_status = TCM_TRANSPORT_ONLINE; 934 return count; 935 } 936 if (!strncmp(page, "offline", 7)) { 937 tl_tpg->tl_transport_status = TCM_TRANSPORT_OFFLINE; 938 if (tl_tpg->tl_nexus) { 939 struct se_session *tl_sess = tl_tpg->tl_nexus->se_sess; 940 941 core_allocate_nexus_loss_ua(tl_sess->se_node_acl); 942 } 943 return count; 944 } 945 return -EINVAL; 946 } 947 948 static ssize_t tcm_loop_tpg_address_show(struct config_item *item, 949 char *page) 950 { 951 struct se_portal_group *se_tpg = to_tpg(item); 952 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 953 struct tcm_loop_tpg, tl_se_tpg); 954 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba; 955 956 return snprintf(page, PAGE_SIZE, "%d:0:%d\n", 957 tl_hba->sh->host_no, tl_tpg->tl_tpgt); 958 } 959 960 CONFIGFS_ATTR(tcm_loop_tpg_, nexus); 961 CONFIGFS_ATTR(tcm_loop_tpg_, transport_status); 962 CONFIGFS_ATTR_RO(tcm_loop_tpg_, address); 963 964 static struct configfs_attribute *tcm_loop_tpg_attrs[] = { 965 &tcm_loop_tpg_attr_nexus, 966 &tcm_loop_tpg_attr_transport_status, 967 &tcm_loop_tpg_attr_address, 968 NULL, 969 }; 970 971 /* Start items for tcm_loop_naa_cit */ 972 973 static struct se_portal_group *tcm_loop_make_naa_tpg(struct se_wwn *wwn, 974 const char *name) 975 { 976 struct tcm_loop_hba *tl_hba = container_of(wwn, 977 struct tcm_loop_hba, tl_hba_wwn); 978 struct tcm_loop_tpg *tl_tpg; 979 int ret; 980 unsigned long tpgt; 981 982 if (strstr(name, "tpgt_") != name) { 983 pr_err("Unable to locate \"tpgt_#\" directory group\n"); 984 return ERR_PTR(-EINVAL); 985 } 986 if (kstrtoul(name+5, 10, &tpgt)) 987 return ERR_PTR(-EINVAL); 988 989 if (tpgt >= TL_TPGS_PER_HBA) { 990 pr_err("Passed tpgt: %lu exceeds TL_TPGS_PER_HBA: %u\n", 991 tpgt, TL_TPGS_PER_HBA); 992 return ERR_PTR(-EINVAL); 993 } 994 tl_tpg = &tl_hba->tl_hba_tpgs[tpgt]; 995 tl_tpg->tl_hba = tl_hba; 996 tl_tpg->tl_tpgt = tpgt; 997 /* 998 * Register the tl_tpg as a emulated TCM Target Endpoint 999 */ 1000 ret = core_tpg_register(wwn, &tl_tpg->tl_se_tpg, tl_hba->tl_proto_id); 1001 if (ret < 0) 1002 return ERR_PTR(-ENOMEM); 1003 1004 pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s Target Port %s,t,0x%04lx\n", 1005 tcm_loop_dump_proto_id(tl_hba), 1006 config_item_name(&wwn->wwn_group.cg_item), tpgt); 1007 return &tl_tpg->tl_se_tpg; 1008 } 1009 1010 static void tcm_loop_drop_naa_tpg( 1011 struct se_portal_group *se_tpg) 1012 { 1013 struct se_wwn *wwn = se_tpg->se_tpg_wwn; 1014 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg, 1015 struct tcm_loop_tpg, tl_se_tpg); 1016 struct tcm_loop_hba *tl_hba; 1017 unsigned short tpgt; 1018 1019 tl_hba = tl_tpg->tl_hba; 1020 tpgt = tl_tpg->tl_tpgt; 1021 /* 1022 * Release the I_T Nexus for the Virtual target link if present 1023 */ 1024 tcm_loop_drop_nexus(tl_tpg); 1025 /* 1026 * Deregister the tl_tpg as a emulated TCM Target Endpoint 1027 */ 1028 core_tpg_deregister(se_tpg); 1029 1030 tl_tpg->tl_hba = NULL; 1031 tl_tpg->tl_tpgt = 0; 1032 1033 pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s Target Port %s,t,0x%04x\n", 1034 tcm_loop_dump_proto_id(tl_hba), 1035 config_item_name(&wwn->wwn_group.cg_item), tpgt); 1036 } 1037 1038 /* End items for tcm_loop_naa_cit */ 1039 1040 /* Start items for tcm_loop_cit */ 1041 1042 static struct se_wwn *tcm_loop_make_scsi_hba( 1043 struct target_fabric_configfs *tf, 1044 struct config_group *group, 1045 const char *name) 1046 { 1047 struct tcm_loop_hba *tl_hba; 1048 struct Scsi_Host *sh; 1049 char *ptr; 1050 int ret, off = 0; 1051 1052 tl_hba = kzalloc(sizeof(*tl_hba), GFP_KERNEL); 1053 if (!tl_hba) 1054 return ERR_PTR(-ENOMEM); 1055 1056 /* 1057 * Determine the emulated Protocol Identifier and Target Port Name 1058 * based on the incoming configfs directory name. 1059 */ 1060 ptr = strstr(name, "naa."); 1061 if (ptr) { 1062 tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS; 1063 goto check_len; 1064 } 1065 ptr = strstr(name, "fc."); 1066 if (ptr) { 1067 tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP; 1068 off = 3; /* Skip over "fc." */ 1069 goto check_len; 1070 } 1071 ptr = strstr(name, "iqn."); 1072 if (!ptr) { 1073 pr_err("Unable to locate prefix for emulated Target Port: %s\n", 1074 name); 1075 ret = -EINVAL; 1076 goto out; 1077 } 1078 tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI; 1079 1080 check_len: 1081 if (strlen(name) >= TL_WWN_ADDR_LEN) { 1082 pr_err("Emulated NAA %s Address: %s, exceeds max: %d\n", 1083 name, tcm_loop_dump_proto_id(tl_hba), TL_WWN_ADDR_LEN); 1084 ret = -EINVAL; 1085 goto out; 1086 } 1087 snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]); 1088 1089 /* 1090 * Call device_register(tl_hba->dev) to register the emulated 1091 * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after 1092 * device_register() callbacks in tcm_loop_driver_probe() 1093 */ 1094 ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt); 1095 if (ret) 1096 goto out; 1097 1098 sh = tl_hba->sh; 1099 tcm_loop_hba_no_cnt++; 1100 pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target %s Address: %s at Linux/SCSI Host ID: %d\n", 1101 tcm_loop_dump_proto_id(tl_hba), name, sh->host_no); 1102 return &tl_hba->tl_hba_wwn; 1103 out: 1104 kfree(tl_hba); 1105 return ERR_PTR(ret); 1106 } 1107 1108 static void tcm_loop_drop_scsi_hba( 1109 struct se_wwn *wwn) 1110 { 1111 struct tcm_loop_hba *tl_hba = container_of(wwn, 1112 struct tcm_loop_hba, tl_hba_wwn); 1113 1114 pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target %s Address: %s at Linux/SCSI Host ID: %d\n", 1115 tcm_loop_dump_proto_id(tl_hba), tl_hba->tl_wwn_address, 1116 tl_hba->sh->host_no); 1117 /* 1118 * Call device_unregister() on the original tl_hba->dev. 1119 * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will 1120 * release *tl_hba; 1121 */ 1122 device_unregister(&tl_hba->dev); 1123 } 1124 1125 /* Start items for tcm_loop_cit */ 1126 static ssize_t tcm_loop_wwn_version_show(struct config_item *item, char *page) 1127 { 1128 return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION); 1129 } 1130 1131 CONFIGFS_ATTR_RO(tcm_loop_wwn_, version); 1132 1133 static struct configfs_attribute *tcm_loop_wwn_attrs[] = { 1134 &tcm_loop_wwn_attr_version, 1135 NULL, 1136 }; 1137 1138 /* End items for tcm_loop_cit */ 1139 1140 static const struct target_core_fabric_ops loop_ops = { 1141 .module = THIS_MODULE, 1142 .fabric_name = "loopback", 1143 .tpg_get_wwn = tcm_loop_get_endpoint_wwn, 1144 .tpg_get_tag = tcm_loop_get_tag, 1145 .tpg_check_demo_mode = tcm_loop_check_demo_mode, 1146 .tpg_check_demo_mode_cache = tcm_loop_check_demo_mode_cache, 1147 .tpg_check_demo_mode_write_protect = 1148 tcm_loop_check_demo_mode_write_protect, 1149 .tpg_check_prod_mode_write_protect = 1150 tcm_loop_check_prod_mode_write_protect, 1151 .tpg_check_prot_fabric_only = tcm_loop_check_prot_fabric_only, 1152 .tpg_get_inst_index = tcm_loop_get_inst_index, 1153 .check_stop_free = tcm_loop_check_stop_free, 1154 .release_cmd = tcm_loop_release_cmd, 1155 .sess_get_index = tcm_loop_sess_get_index, 1156 .write_pending = tcm_loop_write_pending, 1157 .set_default_node_attributes = tcm_loop_set_default_node_attributes, 1158 .get_cmd_state = tcm_loop_get_cmd_state, 1159 .queue_data_in = tcm_loop_queue_data_in, 1160 .queue_status = tcm_loop_queue_status, 1161 .queue_tm_rsp = tcm_loop_queue_tm_rsp, 1162 .aborted_task = tcm_loop_aborted_task, 1163 .fabric_make_wwn = tcm_loop_make_scsi_hba, 1164 .fabric_drop_wwn = tcm_loop_drop_scsi_hba, 1165 .fabric_make_tpg = tcm_loop_make_naa_tpg, 1166 .fabric_drop_tpg = tcm_loop_drop_naa_tpg, 1167 .fabric_post_link = tcm_loop_port_link, 1168 .fabric_pre_unlink = tcm_loop_port_unlink, 1169 .tfc_wwn_attrs = tcm_loop_wwn_attrs, 1170 .tfc_tpg_base_attrs = tcm_loop_tpg_attrs, 1171 .tfc_tpg_attrib_attrs = tcm_loop_tpg_attrib_attrs, 1172 }; 1173 1174 static int __init tcm_loop_fabric_init(void) 1175 { 1176 int ret = -ENOMEM; 1177 1178 tcm_loop_workqueue = alloc_workqueue("tcm_loop", 0, 0); 1179 if (!tcm_loop_workqueue) 1180 goto out; 1181 1182 tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache", 1183 sizeof(struct tcm_loop_cmd), 1184 __alignof__(struct tcm_loop_cmd), 1185 0, NULL); 1186 if (!tcm_loop_cmd_cache) { 1187 pr_debug("kmem_cache_create() for tcm_loop_cmd_cache failed\n"); 1188 goto out_destroy_workqueue; 1189 } 1190 1191 ret = tcm_loop_alloc_core_bus(); 1192 if (ret) 1193 goto out_destroy_cache; 1194 1195 ret = target_register_template(&loop_ops); 1196 if (ret) 1197 goto out_release_core_bus; 1198 1199 return 0; 1200 1201 out_release_core_bus: 1202 tcm_loop_release_core_bus(); 1203 out_destroy_cache: 1204 kmem_cache_destroy(tcm_loop_cmd_cache); 1205 out_destroy_workqueue: 1206 destroy_workqueue(tcm_loop_workqueue); 1207 out: 1208 return ret; 1209 } 1210 1211 static void __exit tcm_loop_fabric_exit(void) 1212 { 1213 target_unregister_template(&loop_ops); 1214 tcm_loop_release_core_bus(); 1215 kmem_cache_destroy(tcm_loop_cmd_cache); 1216 destroy_workqueue(tcm_loop_workqueue); 1217 } 1218 1219 MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module"); 1220 MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>"); 1221 MODULE_LICENSE("GPL"); 1222 module_init(tcm_loop_fabric_init); 1223 module_exit(tcm_loop_fabric_exit); 1224