1 /******************************************************************************* 2 * Filename: tcm_fc.c 3 * 4 * This file contains the configfs implementation for TCM_fc fabric node. 5 * Based on tcm_loop_configfs.c 6 * 7 * Copyright (c) 2010 Cisco Systems, Inc. 8 * Copyright (c) 2009,2010 Rising Tide, Inc. 9 * Copyright (c) 2009,2010 Linux-iSCSI.org 10 * 11 * Copyright (c) 2009,2010 Nicholas A. Bellinger <nab@linux-iscsi.org> 12 * 13 * This program is free software; you can redistribute it and/or modify 14 * it under the terms of the GNU General Public License as published by 15 * the Free Software Foundation; either version 2 of the License, or 16 * (at your option) any later version. 17 * 18 * This program is distributed in the hope that it will be useful, 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 * GNU General Public License for more details. 22 ****************************************************************************/ 23 24 #include <linux/module.h> 25 #include <linux/moduleparam.h> 26 #include <generated/utsrelease.h> 27 #include <linux/utsname.h> 28 #include <linux/init.h> 29 #include <linux/slab.h> 30 #include <linux/kthread.h> 31 #include <linux/types.h> 32 #include <linux/string.h> 33 #include <linux/configfs.h> 34 #include <linux/kernel.h> 35 #include <linux/ctype.h> 36 #include <asm/unaligned.h> 37 #include <scsi/scsi.h> 38 #include <scsi/scsi_host.h> 39 #include <scsi/scsi_device.h> 40 #include <scsi/scsi_cmnd.h> 41 #include <scsi/libfc.h> 42 43 #include <target/target_core_base.h> 44 #include <target/target_core_fabric.h> 45 #include <target/target_core_fabric_configfs.h> 46 #include <target/target_core_configfs.h> 47 #include <target/configfs_macros.h> 48 49 #include "tcm_fc.h" 50 51 static const struct target_core_fabric_ops ft_fabric_ops; 52 53 static LIST_HEAD(ft_wwn_list); 54 DEFINE_MUTEX(ft_lport_lock); 55 56 unsigned int ft_debug_logging; 57 module_param_named(debug_logging, ft_debug_logging, int, S_IRUGO|S_IWUSR); 58 MODULE_PARM_DESC(debug_logging, "a bit mask of logging levels"); 59 60 /* 61 * Parse WWN. 62 * If strict, we require lower-case hex and colon separators to be sure 63 * the name is the same as what would be generated by ft_format_wwn() 64 * so the name and wwn are mapped one-to-one. 65 */ 66 static ssize_t ft_parse_wwn(const char *name, u64 *wwn, int strict) 67 { 68 const char *cp; 69 char c; 70 u32 byte = 0; 71 u32 pos = 0; 72 u32 err; 73 int val; 74 75 *wwn = 0; 76 for (cp = name; cp < &name[FT_NAMELEN - 1]; cp++) { 77 c = *cp; 78 if (c == '\n' && cp[1] == '\0') 79 continue; 80 if (strict && pos++ == 2 && byte++ < 7) { 81 pos = 0; 82 if (c == ':') 83 continue; 84 err = 1; 85 goto fail; 86 } 87 if (c == '\0') { 88 err = 2; 89 if (strict && byte != 8) 90 goto fail; 91 return cp - name; 92 } 93 err = 3; 94 val = hex_to_bin(c); 95 if (val < 0 || (strict && isupper(c))) 96 goto fail; 97 *wwn = (*wwn << 4) | val; 98 } 99 err = 4; 100 fail: 101 pr_debug("err %u len %zu pos %u byte %u\n", 102 err, cp - name, pos, byte); 103 return -1; 104 } 105 106 ssize_t ft_format_wwn(char *buf, size_t len, u64 wwn) 107 { 108 u8 b[8]; 109 110 put_unaligned_be64(wwn, b); 111 return snprintf(buf, len, 112 "%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x", 113 b[0], b[1], b[2], b[3], b[4], b[5], b[6], b[7]); 114 } 115 116 static ssize_t ft_wwn_show(void *arg, char *buf) 117 { 118 u64 *wwn = arg; 119 ssize_t len; 120 121 len = ft_format_wwn(buf, PAGE_SIZE - 2, *wwn); 122 buf[len++] = '\n'; 123 return len; 124 } 125 126 static ssize_t ft_wwn_store(void *arg, const char *buf, size_t len) 127 { 128 ssize_t ret; 129 u64 wwn; 130 131 ret = ft_parse_wwn(buf, &wwn, 0); 132 if (ret > 0) 133 *(u64 *)arg = wwn; 134 return ret; 135 } 136 137 /* 138 * ACL auth ops. 139 */ 140 141 static ssize_t ft_nacl_show_port_name( 142 struct se_node_acl *se_nacl, 143 char *page) 144 { 145 struct ft_node_acl *acl = container_of(se_nacl, 146 struct ft_node_acl, se_node_acl); 147 148 return ft_wwn_show(&acl->node_auth.port_name, page); 149 } 150 151 static ssize_t ft_nacl_store_port_name( 152 struct se_node_acl *se_nacl, 153 const char *page, 154 size_t count) 155 { 156 struct ft_node_acl *acl = container_of(se_nacl, 157 struct ft_node_acl, se_node_acl); 158 159 return ft_wwn_store(&acl->node_auth.port_name, page, count); 160 } 161 162 TF_NACL_BASE_ATTR(ft, port_name, S_IRUGO | S_IWUSR); 163 164 static ssize_t ft_nacl_show_node_name( 165 struct se_node_acl *se_nacl, 166 char *page) 167 { 168 struct ft_node_acl *acl = container_of(se_nacl, 169 struct ft_node_acl, se_node_acl); 170 171 return ft_wwn_show(&acl->node_auth.node_name, page); 172 } 173 174 static ssize_t ft_nacl_store_node_name( 175 struct se_node_acl *se_nacl, 176 const char *page, 177 size_t count) 178 { 179 struct ft_node_acl *acl = container_of(se_nacl, 180 struct ft_node_acl, se_node_acl); 181 182 return ft_wwn_store(&acl->node_auth.node_name, page, count); 183 } 184 185 TF_NACL_BASE_ATTR(ft, node_name, S_IRUGO | S_IWUSR); 186 187 static struct configfs_attribute *ft_nacl_base_attrs[] = { 188 &ft_nacl_port_name.attr, 189 &ft_nacl_node_name.attr, 190 NULL, 191 }; 192 193 /* 194 * ACL ops. 195 */ 196 197 /* 198 * Add ACL for an initiator. The ACL is named arbitrarily. 199 * The port_name and/or node_name are attributes. 200 */ 201 static int ft_init_nodeacl(struct se_node_acl *nacl, const char *name) 202 { 203 struct ft_node_acl *acl = 204 container_of(nacl, struct ft_node_acl, se_node_acl); 205 u64 wwpn; 206 207 if (ft_parse_wwn(name, &wwpn, 1) < 0) 208 return -EINVAL; 209 210 acl->node_auth.port_name = wwpn; 211 return 0; 212 } 213 214 struct ft_node_acl *ft_acl_get(struct ft_tpg *tpg, struct fc_rport_priv *rdata) 215 { 216 struct ft_node_acl *found = NULL; 217 struct ft_node_acl *acl; 218 struct se_portal_group *se_tpg = &tpg->se_tpg; 219 struct se_node_acl *se_acl; 220 221 spin_lock_irq(&se_tpg->acl_node_lock); 222 list_for_each_entry(se_acl, &se_tpg->acl_node_list, acl_list) { 223 acl = container_of(se_acl, struct ft_node_acl, se_node_acl); 224 pr_debug("acl %p port_name %llx\n", 225 acl, (unsigned long long)acl->node_auth.port_name); 226 if (acl->node_auth.port_name == rdata->ids.port_name || 227 acl->node_auth.node_name == rdata->ids.node_name) { 228 pr_debug("acl %p port_name %llx matched\n", acl, 229 (unsigned long long)rdata->ids.port_name); 230 found = acl; 231 /* XXX need to hold onto ACL */ 232 break; 233 } 234 } 235 spin_unlock_irq(&se_tpg->acl_node_lock); 236 return found; 237 } 238 239 /* 240 * local_port port_group (tpg) ops. 241 */ 242 static struct se_portal_group *ft_add_tpg( 243 struct se_wwn *wwn, 244 struct config_group *group, 245 const char *name) 246 { 247 struct ft_lport_wwn *ft_wwn; 248 struct ft_tpg *tpg; 249 struct workqueue_struct *wq; 250 unsigned long index; 251 int ret; 252 253 pr_debug("tcm_fc: add tpg %s\n", name); 254 255 /* 256 * Name must be "tpgt_" followed by the index. 257 */ 258 if (strstr(name, "tpgt_") != name) 259 return NULL; 260 261 ret = kstrtoul(name + 5, 10, &index); 262 if (ret) 263 return NULL; 264 if (index > UINT_MAX) 265 return NULL; 266 267 if ((index != 1)) { 268 pr_err("Error, a single TPG=1 is used for HW port mappings\n"); 269 return ERR_PTR(-ENOSYS); 270 } 271 272 ft_wwn = container_of(wwn, struct ft_lport_wwn, se_wwn); 273 tpg = kzalloc(sizeof(*tpg), GFP_KERNEL); 274 if (!tpg) 275 return NULL; 276 tpg->index = index; 277 tpg->lport_wwn = ft_wwn; 278 INIT_LIST_HEAD(&tpg->lun_list); 279 280 wq = alloc_workqueue("tcm_fc", 0, 1); 281 if (!wq) { 282 kfree(tpg); 283 return NULL; 284 } 285 286 ret = core_tpg_register(&ft_fabric_ops, wwn, &tpg->se_tpg, 287 SCSI_PROTOCOL_FCP); 288 if (ret < 0) { 289 destroy_workqueue(wq); 290 kfree(tpg); 291 return NULL; 292 } 293 tpg->workqueue = wq; 294 295 mutex_lock(&ft_lport_lock); 296 ft_wwn->tpg = tpg; 297 mutex_unlock(&ft_lport_lock); 298 299 return &tpg->se_tpg; 300 } 301 302 static void ft_del_tpg(struct se_portal_group *se_tpg) 303 { 304 struct ft_tpg *tpg = container_of(se_tpg, struct ft_tpg, se_tpg); 305 struct ft_lport_wwn *ft_wwn = tpg->lport_wwn; 306 307 pr_debug("del tpg %s\n", 308 config_item_name(&tpg->se_tpg.tpg_group.cg_item)); 309 310 destroy_workqueue(tpg->workqueue); 311 312 /* Wait for sessions to be freed thru RCU, for BUG_ON below */ 313 synchronize_rcu(); 314 315 mutex_lock(&ft_lport_lock); 316 ft_wwn->tpg = NULL; 317 if (tpg->tport) { 318 tpg->tport->tpg = NULL; 319 tpg->tport = NULL; 320 } 321 mutex_unlock(&ft_lport_lock); 322 323 core_tpg_deregister(se_tpg); 324 kfree(tpg); 325 } 326 327 /* 328 * Verify that an lport is configured to use the tcm_fc module, and return 329 * the target port group that should be used. 330 * 331 * The caller holds ft_lport_lock. 332 */ 333 struct ft_tpg *ft_lport_find_tpg(struct fc_lport *lport) 334 { 335 struct ft_lport_wwn *ft_wwn; 336 337 list_for_each_entry(ft_wwn, &ft_wwn_list, ft_wwn_node) { 338 if (ft_wwn->wwpn == lport->wwpn) 339 return ft_wwn->tpg; 340 } 341 return NULL; 342 } 343 344 /* 345 * target config instance ops. 346 */ 347 348 /* 349 * Add lport to allowed config. 350 * The name is the WWPN in lower-case ASCII, colon-separated bytes. 351 */ 352 static struct se_wwn *ft_add_wwn( 353 struct target_fabric_configfs *tf, 354 struct config_group *group, 355 const char *name) 356 { 357 struct ft_lport_wwn *ft_wwn; 358 struct ft_lport_wwn *old_ft_wwn; 359 u64 wwpn; 360 361 pr_debug("add wwn %s\n", name); 362 if (ft_parse_wwn(name, &wwpn, 1) < 0) 363 return NULL; 364 ft_wwn = kzalloc(sizeof(*ft_wwn), GFP_KERNEL); 365 if (!ft_wwn) 366 return NULL; 367 ft_wwn->wwpn = wwpn; 368 369 mutex_lock(&ft_lport_lock); 370 list_for_each_entry(old_ft_wwn, &ft_wwn_list, ft_wwn_node) { 371 if (old_ft_wwn->wwpn == wwpn) { 372 mutex_unlock(&ft_lport_lock); 373 kfree(ft_wwn); 374 return NULL; 375 } 376 } 377 list_add_tail(&ft_wwn->ft_wwn_node, &ft_wwn_list); 378 ft_format_wwn(ft_wwn->name, sizeof(ft_wwn->name), wwpn); 379 mutex_unlock(&ft_lport_lock); 380 381 return &ft_wwn->se_wwn; 382 } 383 384 static void ft_del_wwn(struct se_wwn *wwn) 385 { 386 struct ft_lport_wwn *ft_wwn = container_of(wwn, 387 struct ft_lport_wwn, se_wwn); 388 389 pr_debug("del wwn %s\n", ft_wwn->name); 390 mutex_lock(&ft_lport_lock); 391 list_del(&ft_wwn->ft_wwn_node); 392 mutex_unlock(&ft_lport_lock); 393 394 kfree(ft_wwn); 395 } 396 397 static ssize_t ft_wwn_show_attr_version( 398 struct target_fabric_configfs *tf, 399 char *page) 400 { 401 return sprintf(page, "TCM FC " FT_VERSION " on %s/%s on " 402 ""UTS_RELEASE"\n", utsname()->sysname, utsname()->machine); 403 } 404 405 TF_WWN_ATTR_RO(ft, version); 406 407 static struct configfs_attribute *ft_wwn_attrs[] = { 408 &ft_wwn_version.attr, 409 NULL, 410 }; 411 412 static inline struct ft_tpg *ft_tpg(struct se_portal_group *se_tpg) 413 { 414 return container_of(se_tpg, struct ft_tpg, se_tpg); 415 } 416 417 static char *ft_get_fabric_name(void) 418 { 419 return "fc"; 420 } 421 422 static char *ft_get_fabric_wwn(struct se_portal_group *se_tpg) 423 { 424 return ft_tpg(se_tpg)->lport_wwn->name; 425 } 426 427 static u16 ft_get_tag(struct se_portal_group *se_tpg) 428 { 429 /* 430 * This tag is used when forming SCSI Name identifier in EVPD=1 0x83 431 * to represent the SCSI Target Port. 432 */ 433 return ft_tpg(se_tpg)->index; 434 } 435 436 static int ft_check_false(struct se_portal_group *se_tpg) 437 { 438 return 0; 439 } 440 441 static void ft_set_default_node_attr(struct se_node_acl *se_nacl) 442 { 443 } 444 445 static u32 ft_tpg_get_inst_index(struct se_portal_group *se_tpg) 446 { 447 return ft_tpg(se_tpg)->index; 448 } 449 450 static const struct target_core_fabric_ops ft_fabric_ops = { 451 .module = THIS_MODULE, 452 .name = "fc", 453 .node_acl_size = sizeof(struct ft_node_acl), 454 .get_fabric_name = ft_get_fabric_name, 455 .get_fabric_proto_ident = fc_get_fabric_proto_ident, 456 .tpg_get_wwn = ft_get_fabric_wwn, 457 .tpg_get_tag = ft_get_tag, 458 .tpg_get_pr_transport_id = fc_get_pr_transport_id, 459 .tpg_get_pr_transport_id_len = fc_get_pr_transport_id_len, 460 .tpg_parse_pr_out_transport_id = fc_parse_pr_out_transport_id, 461 .tpg_check_demo_mode = ft_check_false, 462 .tpg_check_demo_mode_cache = ft_check_false, 463 .tpg_check_demo_mode_write_protect = ft_check_false, 464 .tpg_check_prod_mode_write_protect = ft_check_false, 465 .tpg_get_inst_index = ft_tpg_get_inst_index, 466 .check_stop_free = ft_check_stop_free, 467 .release_cmd = ft_release_cmd, 468 .shutdown_session = ft_sess_shutdown, 469 .close_session = ft_sess_close, 470 .sess_get_index = ft_sess_get_index, 471 .sess_get_initiator_sid = NULL, 472 .write_pending = ft_write_pending, 473 .write_pending_status = ft_write_pending_status, 474 .set_default_node_attributes = ft_set_default_node_attr, 475 .get_task_tag = ft_get_task_tag, 476 .get_cmd_state = ft_get_cmd_state, 477 .queue_data_in = ft_queue_data_in, 478 .queue_status = ft_queue_status, 479 .queue_tm_rsp = ft_queue_tm_resp, 480 .aborted_task = ft_aborted_task, 481 /* 482 * Setup function pointers for generic logic in 483 * target_core_fabric_configfs.c 484 */ 485 .fabric_make_wwn = &ft_add_wwn, 486 .fabric_drop_wwn = &ft_del_wwn, 487 .fabric_make_tpg = &ft_add_tpg, 488 .fabric_drop_tpg = &ft_del_tpg, 489 .fabric_init_nodeacl = &ft_init_nodeacl, 490 491 .tfc_wwn_attrs = ft_wwn_attrs, 492 .tfc_tpg_nacl_base_attrs = ft_nacl_base_attrs, 493 }; 494 495 static struct notifier_block ft_notifier = { 496 .notifier_call = ft_lport_notify 497 }; 498 499 static int __init ft_init(void) 500 { 501 int ret; 502 503 ret = target_register_template(&ft_fabric_ops); 504 if (ret) 505 goto out; 506 507 ret = fc_fc4_register_provider(FC_TYPE_FCP, &ft_prov); 508 if (ret) 509 goto out_unregister_template; 510 511 blocking_notifier_chain_register(&fc_lport_notifier_head, &ft_notifier); 512 fc_lport_iterate(ft_lport_add, NULL); 513 return 0; 514 515 out_unregister_template: 516 target_unregister_template(&ft_fabric_ops); 517 out: 518 return ret; 519 } 520 521 static void __exit ft_exit(void) 522 { 523 blocking_notifier_chain_unregister(&fc_lport_notifier_head, 524 &ft_notifier); 525 fc_fc4_deregister_provider(FC_TYPE_FCP, &ft_prov); 526 fc_lport_iterate(ft_lport_del, NULL); 527 target_unregister_template(&ft_fabric_ops); 528 synchronize_rcu(); 529 } 530 531 MODULE_DESCRIPTION("FC TCM fabric driver " FT_VERSION); 532 MODULE_LICENSE("GPL"); 533 module_init(ft_init); 534 module_exit(ft_exit); 535