1 /*******************************************************************************
4 * This file contains the configfs implementation for TCM_fc fabric node.
5 * Based on tcm_loop_configfs.c
7 * Copyright (c) 2010 Cisco Systems, Inc.
8 * Copyright (c) 2009,2010 Rising Tide, Inc.
9 * Copyright (c) 2009,2010 Linux-iSCSI.org
11 * Copyright (c) 2009,2010 Nicholas A. Bellinger <nab@linux-iscsi.org>
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.
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 ****************************************************************************/
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>
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>
51 struct target_fabric_configfs
*ft_configfs
;
53 LIST_HEAD(ft_lport_list
);
54 DEFINE_MUTEX(ft_lport_lock
);
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");
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.
66 static ssize_t
ft_parse_wwn(const char *name
, u64
*wwn
, int strict
)
76 for (cp
= name
; cp
< &name
[FT_NAMELEN
- 1]; cp
++) {
78 if (c
== '\n' && cp
[1] == '\0')
80 if (strict
&& pos
++ == 2 && byte
++ < 7) {
89 if (strict
&& byte
!= 8)
95 if (val
< 0 || (strict
&& isupper(c
)))
97 *wwn
= (*wwn
<< 4) | val
;
101 pr_debug("err %u len %zu pos %u byte %u\n",
102 err
, cp
- name
, pos
, byte
);
106 ssize_t
ft_format_wwn(char *buf
, size_t len
, u64 wwn
)
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]);
116 static ssize_t
ft_wwn_show(void *arg
, char *buf
)
121 len
= ft_format_wwn(buf
, PAGE_SIZE
- 2, *wwn
);
126 static ssize_t
ft_wwn_store(void *arg
, const char *buf
, size_t len
)
131 ret
= ft_parse_wwn(buf
, &wwn
, 0);
141 static ssize_t
ft_nacl_show_port_name(
142 struct se_node_acl
*se_nacl
,
145 struct ft_node_acl
*acl
= container_of(se_nacl
,
146 struct ft_node_acl
, se_node_acl
);
148 return ft_wwn_show(&acl
->node_auth
.port_name
, page
);
151 static ssize_t
ft_nacl_store_port_name(
152 struct se_node_acl
*se_nacl
,
156 struct ft_node_acl
*acl
= container_of(se_nacl
,
157 struct ft_node_acl
, se_node_acl
);
159 return ft_wwn_store(&acl
->node_auth
.port_name
, page
, count
);
162 TF_NACL_BASE_ATTR(ft
, port_name
, S_IRUGO
| S_IWUSR
);
164 static ssize_t
ft_nacl_show_node_name(
165 struct se_node_acl
*se_nacl
,
168 struct ft_node_acl
*acl
= container_of(se_nacl
,
169 struct ft_node_acl
, se_node_acl
);
171 return ft_wwn_show(&acl
->node_auth
.node_name
, page
);
174 static ssize_t
ft_nacl_store_node_name(
175 struct se_node_acl
*se_nacl
,
179 struct ft_node_acl
*acl
= container_of(se_nacl
,
180 struct ft_node_acl
, se_node_acl
);
182 return ft_wwn_store(&acl
->node_auth
.node_name
, page
, count
);
185 TF_NACL_BASE_ATTR(ft
, node_name
, S_IRUGO
| S_IWUSR
);
187 static struct configfs_attribute
*ft_nacl_base_attrs
[] = {
188 &ft_nacl_port_name
.attr
,
189 &ft_nacl_node_name
.attr
,
198 * Add ACL for an initiator. The ACL is named arbitrarily.
199 * The port_name and/or node_name are attributes.
201 static struct se_node_acl
*ft_add_acl(
202 struct se_portal_group
*se_tpg
,
203 struct config_group
*group
,
206 struct ft_node_acl
*acl
;
211 pr_debug("add acl %s\n", name
);
212 tpg
= container_of(se_tpg
, struct ft_tpg
, se_tpg
);
214 if (ft_parse_wwn(name
, &wwpn
, 1) < 0)
215 return ERR_PTR(-EINVAL
);
217 acl
= kzalloc(sizeof(struct ft_node_acl
), GFP_KERNEL
);
219 return ERR_PTR(-ENOMEM
);
220 acl
->node_auth
.port_name
= wwpn
;
222 q_depth
= 32; /* XXX bogus default - get from tpg? */
223 return core_tpg_add_initiator_node_acl(&tpg
->se_tpg
,
224 &acl
->se_node_acl
, name
, q_depth
);
227 static void ft_del_acl(struct se_node_acl
*se_acl
)
229 struct se_portal_group
*se_tpg
= se_acl
->se_tpg
;
231 struct ft_node_acl
*acl
= container_of(se_acl
,
232 struct ft_node_acl
, se_node_acl
);
234 pr_debug("del acl %s\n",
235 config_item_name(&se_acl
->acl_group
.cg_item
));
237 tpg
= container_of(se_tpg
, struct ft_tpg
, se_tpg
);
238 pr_debug("del acl %p se_acl %p tpg %p se_tpg %p\n",
239 acl
, se_acl
, tpg
, &tpg
->se_tpg
);
241 core_tpg_del_initiator_node_acl(&tpg
->se_tpg
, se_acl
, 1);
245 struct ft_node_acl
*ft_acl_get(struct ft_tpg
*tpg
, struct fc_rport_priv
*rdata
)
247 struct ft_node_acl
*found
= NULL
;
248 struct ft_node_acl
*acl
;
249 struct se_portal_group
*se_tpg
= &tpg
->se_tpg
;
250 struct se_node_acl
*se_acl
;
252 spin_lock_irq(&se_tpg
->acl_node_lock
);
253 list_for_each_entry(se_acl
, &se_tpg
->acl_node_list
, acl_list
) {
254 acl
= container_of(se_acl
, struct ft_node_acl
, se_node_acl
);
255 pr_debug("acl %p port_name %llx\n",
256 acl
, (unsigned long long)acl
->node_auth
.port_name
);
257 if (acl
->node_auth
.port_name
== rdata
->ids
.port_name
||
258 acl
->node_auth
.node_name
== rdata
->ids
.node_name
) {
259 pr_debug("acl %p port_name %llx matched\n", acl
,
260 (unsigned long long)rdata
->ids
.port_name
);
262 /* XXX need to hold onto ACL */
266 spin_unlock_irq(&se_tpg
->acl_node_lock
);
270 struct se_node_acl
*ft_tpg_alloc_fabric_acl(struct se_portal_group
*se_tpg
)
272 struct ft_node_acl
*acl
;
274 acl
= kzalloc(sizeof(*acl
), GFP_KERNEL
);
276 pr_err("Unable to allocate struct ft_node_acl\n");
279 pr_debug("acl %p\n", acl
);
280 return &acl
->se_node_acl
;
283 static void ft_tpg_release_fabric_acl(struct se_portal_group
*se_tpg
,
284 struct se_node_acl
*se_acl
)
286 struct ft_node_acl
*acl
= container_of(se_acl
,
287 struct ft_node_acl
, se_node_acl
);
289 pr_debug("acl %p\n", acl
);
294 * local_port port_group (tpg) ops.
296 static struct se_portal_group
*ft_add_tpg(
298 struct config_group
*group
,
301 struct ft_lport_acl
*lacl
;
303 struct workqueue_struct
*wq
;
307 pr_debug("tcm_fc: add tpg %s\n", name
);
310 * Name must be "tpgt_" followed by the index.
312 if (strstr(name
, "tpgt_") != name
)
314 if (strict_strtoul(name
+ 5, 10, &index
) || index
> UINT_MAX
)
317 lacl
= container_of(wwn
, struct ft_lport_acl
, fc_lport_wwn
);
318 tpg
= kzalloc(sizeof(*tpg
), GFP_KERNEL
);
322 tpg
->lport_acl
= lacl
;
323 INIT_LIST_HEAD(&tpg
->lun_list
);
325 wq
= alloc_workqueue("tcm_fc", 0, 1);
331 ret
= core_tpg_register(&ft_configfs
->tf_ops
, wwn
, &tpg
->se_tpg
,
332 tpg
, TRANSPORT_TPG_TYPE_NORMAL
);
334 destroy_workqueue(wq
);
340 mutex_lock(&ft_lport_lock
);
341 list_add_tail(&tpg
->list
, &lacl
->tpg_list
);
342 mutex_unlock(&ft_lport_lock
);
347 static void ft_del_tpg(struct se_portal_group
*se_tpg
)
349 struct ft_tpg
*tpg
= container_of(se_tpg
, struct ft_tpg
, se_tpg
);
351 pr_debug("del tpg %s\n",
352 config_item_name(&tpg
->se_tpg
.tpg_group
.cg_item
));
354 destroy_workqueue(tpg
->workqueue
);
356 /* Wait for sessions to be freed thru RCU, for BUG_ON below */
359 mutex_lock(&ft_lport_lock
);
360 list_del(&tpg
->list
);
362 tpg
->tport
->tpg
= NULL
;
365 mutex_unlock(&ft_lport_lock
);
367 core_tpg_deregister(se_tpg
);
372 * Verify that an lport is configured to use the tcm_fc module, and return
373 * the target port group that should be used.
375 * The caller holds ft_lport_lock.
377 struct ft_tpg
*ft_lport_find_tpg(struct fc_lport
*lport
)
379 struct ft_lport_acl
*lacl
;
382 list_for_each_entry(lacl
, &ft_lport_list
, list
) {
383 if (lacl
->wwpn
== lport
->wwpn
) {
384 list_for_each_entry(tpg
, &lacl
->tpg_list
, list
)
385 return tpg
; /* XXX for now return first entry */
393 * target config instance ops.
397 * Add lport to allowed config.
398 * The name is the WWPN in lower-case ASCII, colon-separated bytes.
400 static struct se_wwn
*ft_add_lport(
401 struct target_fabric_configfs
*tf
,
402 struct config_group
*group
,
405 struct ft_lport_acl
*lacl
;
406 struct ft_lport_acl
*old_lacl
;
409 pr_debug("add lport %s\n", name
);
410 if (ft_parse_wwn(name
, &wwpn
, 1) < 0)
412 lacl
= kzalloc(sizeof(*lacl
), GFP_KERNEL
);
416 INIT_LIST_HEAD(&lacl
->tpg_list
);
418 mutex_lock(&ft_lport_lock
);
419 list_for_each_entry(old_lacl
, &ft_lport_list
, list
) {
420 if (old_lacl
->wwpn
== wwpn
) {
421 mutex_unlock(&ft_lport_lock
);
426 list_add_tail(&lacl
->list
, &ft_lport_list
);
427 ft_format_wwn(lacl
->name
, sizeof(lacl
->name
), wwpn
);
428 mutex_unlock(&ft_lport_lock
);
430 return &lacl
->fc_lport_wwn
;
433 static void ft_del_lport(struct se_wwn
*wwn
)
435 struct ft_lport_acl
*lacl
= container_of(wwn
,
436 struct ft_lport_acl
, fc_lport_wwn
);
438 pr_debug("del lport %s\n", lacl
->name
);
439 mutex_lock(&ft_lport_lock
);
440 list_del(&lacl
->list
);
441 mutex_unlock(&ft_lport_lock
);
446 static ssize_t
ft_wwn_show_attr_version(
447 struct target_fabric_configfs
*tf
,
450 return sprintf(page
, "TCM FC " FT_VERSION
" on %s/%s on "
451 ""UTS_RELEASE
"\n", utsname()->sysname
, utsname()->machine
);
454 TF_WWN_ATTR_RO(ft
, version
);
456 static struct configfs_attribute
*ft_wwn_attrs
[] = {
457 &ft_wwn_version
.attr
,
461 static char *ft_get_fabric_name(void)
466 static char *ft_get_fabric_wwn(struct se_portal_group
*se_tpg
)
468 struct ft_tpg
*tpg
= se_tpg
->se_tpg_fabric_ptr
;
470 return tpg
->lport_acl
->name
;
473 static u16
ft_get_tag(struct se_portal_group
*se_tpg
)
475 struct ft_tpg
*tpg
= se_tpg
->se_tpg_fabric_ptr
;
478 * This tag is used when forming SCSI Name identifier in EVPD=1 0x83
479 * to represent the SCSI Target Port.
484 static u32
ft_get_default_depth(struct se_portal_group
*se_tpg
)
489 static int ft_check_false(struct se_portal_group
*se_tpg
)
494 static void ft_set_default_node_attr(struct se_node_acl
*se_nacl
)
498 static u16
ft_get_fabric_sense_len(void)
503 static u16
ft_set_fabric_sense_len(struct se_cmd
*se_cmd
, u32 sense_len
)
508 static u32
ft_tpg_get_inst_index(struct se_portal_group
*se_tpg
)
510 struct ft_tpg
*tpg
= se_tpg
->se_tpg_fabric_ptr
;
515 static struct target_core_fabric_ops ft_fabric_ops
= {
516 .get_fabric_name
= ft_get_fabric_name
,
517 .get_fabric_proto_ident
= fc_get_fabric_proto_ident
,
518 .tpg_get_wwn
= ft_get_fabric_wwn
,
519 .tpg_get_tag
= ft_get_tag
,
520 .tpg_get_default_depth
= ft_get_default_depth
,
521 .tpg_get_pr_transport_id
= fc_get_pr_transport_id
,
522 .tpg_get_pr_transport_id_len
= fc_get_pr_transport_id_len
,
523 .tpg_parse_pr_out_transport_id
= fc_parse_pr_out_transport_id
,
524 .tpg_check_demo_mode
= ft_check_false
,
525 .tpg_check_demo_mode_cache
= ft_check_false
,
526 .tpg_check_demo_mode_write_protect
= ft_check_false
,
527 .tpg_check_prod_mode_write_protect
= ft_check_false
,
528 .tpg_alloc_fabric_acl
= ft_tpg_alloc_fabric_acl
,
529 .tpg_release_fabric_acl
= ft_tpg_release_fabric_acl
,
530 .tpg_get_inst_index
= ft_tpg_get_inst_index
,
531 .check_stop_free
= ft_check_stop_free
,
532 .release_cmd
= ft_release_cmd
,
533 .shutdown_session
= ft_sess_shutdown
,
534 .close_session
= ft_sess_close
,
535 .stop_session
= ft_sess_stop
,
536 .fall_back_to_erl0
= ft_sess_set_erl0
,
537 .sess_logged_in
= ft_sess_logged_in
,
538 .sess_get_index
= ft_sess_get_index
,
539 .sess_get_initiator_sid
= NULL
,
540 .write_pending
= ft_write_pending
,
541 .write_pending_status
= ft_write_pending_status
,
542 .set_default_node_attributes
= ft_set_default_node_attr
,
543 .get_task_tag
= ft_get_task_tag
,
544 .get_cmd_state
= ft_get_cmd_state
,
545 .queue_data_in
= ft_queue_data_in
,
546 .queue_status
= ft_queue_status
,
547 .queue_tm_rsp
= ft_queue_tm_resp
,
548 .get_fabric_sense_len
= ft_get_fabric_sense_len
,
549 .set_fabric_sense_len
= ft_set_fabric_sense_len
,
550 .is_state_remove
= ft_is_state_remove
,
552 * Setup function pointers for generic logic in
553 * target_core_fabric_configfs.c
555 .fabric_make_wwn
= &ft_add_lport
,
556 .fabric_drop_wwn
= &ft_del_lport
,
557 .fabric_make_tpg
= &ft_add_tpg
,
558 .fabric_drop_tpg
= &ft_del_tpg
,
559 .fabric_post_link
= NULL
,
560 .fabric_pre_unlink
= NULL
,
561 .fabric_make_np
= NULL
,
562 .fabric_drop_np
= NULL
,
563 .fabric_make_nodeacl
= &ft_add_acl
,
564 .fabric_drop_nodeacl
= &ft_del_acl
,
567 int ft_register_configfs(void)
569 struct target_fabric_configfs
*fabric
;
573 * Register the top level struct config_item_type with TCM core
575 fabric
= target_fabric_configfs_init(THIS_MODULE
, "fc");
576 if (IS_ERR(fabric
)) {
577 pr_err("%s: target_fabric_configfs_init() failed!\n",
579 return PTR_ERR(fabric
);
581 fabric
->tf_ops
= ft_fabric_ops
;
583 /* Allowing support for task_sg_chaining */
584 fabric
->tf_ops
.task_sg_chaining
= 1;
587 * Setup default attribute lists for various fabric->tf_cit_tmpl
589 TF_CIT_TMPL(fabric
)->tfc_wwn_cit
.ct_attrs
= ft_wwn_attrs
;
590 TF_CIT_TMPL(fabric
)->tfc_tpg_base_cit
.ct_attrs
= NULL
;
591 TF_CIT_TMPL(fabric
)->tfc_tpg_attrib_cit
.ct_attrs
= NULL
;
592 TF_CIT_TMPL(fabric
)->tfc_tpg_param_cit
.ct_attrs
= NULL
;
593 TF_CIT_TMPL(fabric
)->tfc_tpg_np_base_cit
.ct_attrs
= NULL
;
594 TF_CIT_TMPL(fabric
)->tfc_tpg_nacl_base_cit
.ct_attrs
=
596 TF_CIT_TMPL(fabric
)->tfc_tpg_nacl_attrib_cit
.ct_attrs
= NULL
;
597 TF_CIT_TMPL(fabric
)->tfc_tpg_nacl_auth_cit
.ct_attrs
= NULL
;
598 TF_CIT_TMPL(fabric
)->tfc_tpg_nacl_param_cit
.ct_attrs
= NULL
;
600 * register the fabric for use within TCM
602 ret
= target_fabric_configfs_register(fabric
);
604 pr_debug("target_fabric_configfs_register() for"
605 " FC Target failed!\n");
606 target_fabric_configfs_free(fabric
);
611 * Setup our local pointer to *fabric.
613 ft_configfs
= fabric
;
617 void ft_deregister_configfs(void)
621 target_fabric_configfs_deregister(ft_configfs
);
625 static struct notifier_block ft_notifier
= {
626 .notifier_call
= ft_lport_notify
629 static int __init
ft_init(void)
631 if (ft_register_configfs())
633 if (fc_fc4_register_provider(FC_TYPE_FCP
, &ft_prov
)) {
634 ft_deregister_configfs();
637 blocking_notifier_chain_register(&fc_lport_notifier_head
, &ft_notifier
);
638 fc_lport_iterate(ft_lport_add
, NULL
);
642 static void __exit
ft_exit(void)
644 blocking_notifier_chain_unregister(&fc_lport_notifier_head
,
646 fc_fc4_deregister_provider(FC_TYPE_FCP
, &ft_prov
);
647 fc_lport_iterate(ft_lport_del
, NULL
);
648 ft_deregister_configfs();
652 MODULE_DESCRIPTION("FC TCM fabric driver " FT_VERSION
);
653 MODULE_LICENSE("GPL");
654 module_init(ft_init
);
655 module_exit(ft_exit
);