Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/geert/linux...
[linux-btrfs-devel.git] / drivers / target / tcm_fc / tfc_conf.c
blob8fa39b74f22c4a178ed714f123131521f0d78e84
1 /*******************************************************************************
2 * Filename: tcm_fc.c
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 <linux/version.h>
27 #include <generated/utsrelease.h>
28 #include <linux/utsname.h>
29 #include <linux/init.h>
30 #include <linux/slab.h>
31 #include <linux/kthread.h>
32 #include <linux/types.h>
33 #include <linux/string.h>
34 #include <linux/configfs.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_transport.h>
45 #include <target/target_core_fabric_ops.h>
46 #include <target/target_core_fabric_configfs.h>
47 #include <target/target_core_fabric_lib.h>
48 #include <target/target_core_device.h>
49 #include <target/target_core_tpg.h>
50 #include <target/target_core_configfs.h>
51 #include <target/configfs_macros.h>
53 #include "tcm_fc.h"
55 struct target_fabric_configfs *ft_configfs;
57 LIST_HEAD(ft_lport_list);
58 DEFINE_MUTEX(ft_lport_lock);
60 unsigned int ft_debug_logging;
61 module_param_named(debug_logging, ft_debug_logging, int, S_IRUGO|S_IWUSR);
62 MODULE_PARM_DESC(debug_logging, "a bit mask of logging levels");
65 * Parse WWN.
66 * If strict, we require lower-case hex and colon separators to be sure
67 * the name is the same as what would be generated by ft_format_wwn()
68 * so the name and wwn are mapped one-to-one.
70 static ssize_t ft_parse_wwn(const char *name, u64 *wwn, int strict)
72 const char *cp;
73 char c;
74 u32 nibble;
75 u32 byte = 0;
76 u32 pos = 0;
77 u32 err;
79 *wwn = 0;
80 for (cp = name; cp < &name[FT_NAMELEN - 1]; cp++) {
81 c = *cp;
82 if (c == '\n' && cp[1] == '\0')
83 continue;
84 if (strict && pos++ == 2 && byte++ < 7) {
85 pos = 0;
86 if (c == ':')
87 continue;
88 err = 1;
89 goto fail;
91 if (c == '\0') {
92 err = 2;
93 if (strict && byte != 8)
94 goto fail;
95 return cp - name;
97 err = 3;
98 if (isdigit(c))
99 nibble = c - '0';
100 else if (isxdigit(c) && (islower(c) || !strict))
101 nibble = tolower(c) - 'a' + 10;
102 else
103 goto fail;
104 *wwn = (*wwn << 4) | nibble;
106 err = 4;
107 fail:
108 pr_debug("err %u len %zu pos %u byte %u\n",
109 err, cp - name, pos, byte);
110 return -1;
113 ssize_t ft_format_wwn(char *buf, size_t len, u64 wwn)
115 u8 b[8];
117 put_unaligned_be64(wwn, b);
118 return snprintf(buf, len,
119 "%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
120 b[0], b[1], b[2], b[3], b[4], b[5], b[6], b[7]);
123 static ssize_t ft_wwn_show(void *arg, char *buf)
125 u64 *wwn = arg;
126 ssize_t len;
128 len = ft_format_wwn(buf, PAGE_SIZE - 2, *wwn);
129 buf[len++] = '\n';
130 return len;
133 static ssize_t ft_wwn_store(void *arg, const char *buf, size_t len)
135 ssize_t ret;
136 u64 wwn;
138 ret = ft_parse_wwn(buf, &wwn, 0);
139 if (ret > 0)
140 *(u64 *)arg = wwn;
141 return ret;
145 * ACL auth ops.
148 static ssize_t ft_nacl_show_port_name(
149 struct se_node_acl *se_nacl,
150 char *page)
152 struct ft_node_acl *acl = container_of(se_nacl,
153 struct ft_node_acl, se_node_acl);
155 return ft_wwn_show(&acl->node_auth.port_name, page);
158 static ssize_t ft_nacl_store_port_name(
159 struct se_node_acl *se_nacl,
160 const char *page,
161 size_t count)
163 struct ft_node_acl *acl = container_of(se_nacl,
164 struct ft_node_acl, se_node_acl);
166 return ft_wwn_store(&acl->node_auth.port_name, page, count);
169 TF_NACL_BASE_ATTR(ft, port_name, S_IRUGO | S_IWUSR);
171 static ssize_t ft_nacl_show_node_name(
172 struct se_node_acl *se_nacl,
173 char *page)
175 struct ft_node_acl *acl = container_of(se_nacl,
176 struct ft_node_acl, se_node_acl);
178 return ft_wwn_show(&acl->node_auth.node_name, page);
181 static ssize_t ft_nacl_store_node_name(
182 struct se_node_acl *se_nacl,
183 const char *page,
184 size_t count)
186 struct ft_node_acl *acl = container_of(se_nacl,
187 struct ft_node_acl, se_node_acl);
189 return ft_wwn_store(&acl->node_auth.node_name, page, count);
192 TF_NACL_BASE_ATTR(ft, node_name, S_IRUGO | S_IWUSR);
194 static struct configfs_attribute *ft_nacl_base_attrs[] = {
195 &ft_nacl_port_name.attr,
196 &ft_nacl_node_name.attr,
197 NULL,
201 * ACL ops.
205 * Add ACL for an initiator. The ACL is named arbitrarily.
206 * The port_name and/or node_name are attributes.
208 static struct se_node_acl *ft_add_acl(
209 struct se_portal_group *se_tpg,
210 struct config_group *group,
211 const char *name)
213 struct ft_node_acl *acl;
214 struct ft_tpg *tpg;
215 u64 wwpn;
216 u32 q_depth;
218 pr_debug("add acl %s\n", name);
219 tpg = container_of(se_tpg, struct ft_tpg, se_tpg);
221 if (ft_parse_wwn(name, &wwpn, 1) < 0)
222 return ERR_PTR(-EINVAL);
224 acl = kzalloc(sizeof(struct ft_node_acl), GFP_KERNEL);
225 if (!acl)
226 return ERR_PTR(-ENOMEM);
227 acl->node_auth.port_name = wwpn;
229 q_depth = 32; /* XXX bogus default - get from tpg? */
230 return core_tpg_add_initiator_node_acl(&tpg->se_tpg,
231 &acl->se_node_acl, name, q_depth);
234 static void ft_del_acl(struct se_node_acl *se_acl)
236 struct se_portal_group *se_tpg = se_acl->se_tpg;
237 struct ft_tpg *tpg;
238 struct ft_node_acl *acl = container_of(se_acl,
239 struct ft_node_acl, se_node_acl);
241 pr_debug("del acl %s\n",
242 config_item_name(&se_acl->acl_group.cg_item));
244 tpg = container_of(se_tpg, struct ft_tpg, se_tpg);
245 pr_debug("del acl %p se_acl %p tpg %p se_tpg %p\n",
246 acl, se_acl, tpg, &tpg->se_tpg);
248 core_tpg_del_initiator_node_acl(&tpg->se_tpg, se_acl, 1);
249 kfree(acl);
252 struct ft_node_acl *ft_acl_get(struct ft_tpg *tpg, struct fc_rport_priv *rdata)
254 struct ft_node_acl *found = NULL;
255 struct ft_node_acl *acl;
256 struct se_portal_group *se_tpg = &tpg->se_tpg;
257 struct se_node_acl *se_acl;
259 spin_lock_irq(&se_tpg->acl_node_lock);
260 list_for_each_entry(se_acl, &se_tpg->acl_node_list, acl_list) {
261 acl = container_of(se_acl, struct ft_node_acl, se_node_acl);
262 pr_debug("acl %p port_name %llx\n",
263 acl, (unsigned long long)acl->node_auth.port_name);
264 if (acl->node_auth.port_name == rdata->ids.port_name ||
265 acl->node_auth.node_name == rdata->ids.node_name) {
266 pr_debug("acl %p port_name %llx matched\n", acl,
267 (unsigned long long)rdata->ids.port_name);
268 found = acl;
269 /* XXX need to hold onto ACL */
270 break;
273 spin_unlock_irq(&se_tpg->acl_node_lock);
274 return found;
277 struct se_node_acl *ft_tpg_alloc_fabric_acl(struct se_portal_group *se_tpg)
279 struct ft_node_acl *acl;
281 acl = kzalloc(sizeof(*acl), GFP_KERNEL);
282 if (!acl) {
283 pr_err("Unable to allocate struct ft_node_acl\n");
284 return NULL;
286 pr_debug("acl %p\n", acl);
287 return &acl->se_node_acl;
290 static void ft_tpg_release_fabric_acl(struct se_portal_group *se_tpg,
291 struct se_node_acl *se_acl)
293 struct ft_node_acl *acl = container_of(se_acl,
294 struct ft_node_acl, se_node_acl);
296 pr_debug("acl %p\n", acl);
297 kfree(acl);
301 * local_port port_group (tpg) ops.
303 static struct se_portal_group *ft_add_tpg(
304 struct se_wwn *wwn,
305 struct config_group *group,
306 const char *name)
308 struct ft_lport_acl *lacl;
309 struct ft_tpg *tpg;
310 unsigned long index;
311 int ret;
313 pr_debug("tcm_fc: add tpg %s\n", name);
316 * Name must be "tpgt_" followed by the index.
318 if (strstr(name, "tpgt_") != name)
319 return NULL;
320 if (strict_strtoul(name + 5, 10, &index) || index > UINT_MAX)
321 return NULL;
323 lacl = container_of(wwn, struct ft_lport_acl, fc_lport_wwn);
324 tpg = kzalloc(sizeof(*tpg), GFP_KERNEL);
325 if (!tpg)
326 return NULL;
327 tpg->index = index;
328 tpg->lport_acl = lacl;
329 INIT_LIST_HEAD(&tpg->lun_list);
331 ret = core_tpg_register(&ft_configfs->tf_ops, wwn, &tpg->se_tpg,
332 tpg, TRANSPORT_TPG_TYPE_NORMAL);
333 if (ret < 0) {
334 kfree(tpg);
335 return NULL;
338 tpg->workqueue = alloc_workqueue("tcm_fc", 0, 1);
339 if (!tpg->workqueue) {
340 kfree(tpg);
341 return NULL;
344 mutex_lock(&ft_lport_lock);
345 list_add_tail(&tpg->list, &lacl->tpg_list);
346 mutex_unlock(&ft_lport_lock);
348 return &tpg->se_tpg;
351 static void ft_del_tpg(struct se_portal_group *se_tpg)
353 struct ft_tpg *tpg = container_of(se_tpg, struct ft_tpg, se_tpg);
355 pr_debug("del tpg %s\n",
356 config_item_name(&tpg->se_tpg.tpg_group.cg_item));
358 destroy_workqueue(tpg->workqueue);
360 /* Wait for sessions to be freed thru RCU, for BUG_ON below */
361 synchronize_rcu();
363 mutex_lock(&ft_lport_lock);
364 list_del(&tpg->list);
365 if (tpg->tport) {
366 tpg->tport->tpg = NULL;
367 tpg->tport = NULL;
369 mutex_unlock(&ft_lport_lock);
371 core_tpg_deregister(se_tpg);
372 kfree(tpg);
376 * Verify that an lport is configured to use the tcm_fc module, and return
377 * the target port group that should be used.
379 * The caller holds ft_lport_lock.
381 struct ft_tpg *ft_lport_find_tpg(struct fc_lport *lport)
383 struct ft_lport_acl *lacl;
384 struct ft_tpg *tpg;
386 list_for_each_entry(lacl, &ft_lport_list, list) {
387 if (lacl->wwpn == lport->wwpn) {
388 list_for_each_entry(tpg, &lacl->tpg_list, list)
389 return tpg; /* XXX for now return first entry */
390 return NULL;
393 return NULL;
397 * target config instance ops.
401 * Add lport to allowed config.
402 * The name is the WWPN in lower-case ASCII, colon-separated bytes.
404 static struct se_wwn *ft_add_lport(
405 struct target_fabric_configfs *tf,
406 struct config_group *group,
407 const char *name)
409 struct ft_lport_acl *lacl;
410 struct ft_lport_acl *old_lacl;
411 u64 wwpn;
413 pr_debug("add lport %s\n", name);
414 if (ft_parse_wwn(name, &wwpn, 1) < 0)
415 return NULL;
416 lacl = kzalloc(sizeof(*lacl), GFP_KERNEL);
417 if (!lacl)
418 return NULL;
419 lacl->wwpn = wwpn;
420 INIT_LIST_HEAD(&lacl->tpg_list);
422 mutex_lock(&ft_lport_lock);
423 list_for_each_entry(old_lacl, &ft_lport_list, list) {
424 if (old_lacl->wwpn == wwpn) {
425 mutex_unlock(&ft_lport_lock);
426 kfree(lacl);
427 return NULL;
430 list_add_tail(&lacl->list, &ft_lport_list);
431 ft_format_wwn(lacl->name, sizeof(lacl->name), wwpn);
432 mutex_unlock(&ft_lport_lock);
434 return &lacl->fc_lport_wwn;
437 static void ft_del_lport(struct se_wwn *wwn)
439 struct ft_lport_acl *lacl = container_of(wwn,
440 struct ft_lport_acl, fc_lport_wwn);
442 pr_debug("del lport %s\n",
443 config_item_name(&wwn->wwn_group.cg_item));
444 mutex_lock(&ft_lport_lock);
445 list_del(&lacl->list);
446 mutex_unlock(&ft_lport_lock);
448 kfree(lacl);
451 static ssize_t ft_wwn_show_attr_version(
452 struct target_fabric_configfs *tf,
453 char *page)
455 return sprintf(page, "TCM FC " FT_VERSION " on %s/%s on "
456 ""UTS_RELEASE"\n", utsname()->sysname, utsname()->machine);
459 TF_WWN_ATTR_RO(ft, version);
461 static struct configfs_attribute *ft_wwn_attrs[] = {
462 &ft_wwn_version.attr,
463 NULL,
466 static char *ft_get_fabric_name(void)
468 return "fc";
471 static char *ft_get_fabric_wwn(struct se_portal_group *se_tpg)
473 struct ft_tpg *tpg = se_tpg->se_tpg_fabric_ptr;
475 return tpg->lport_acl->name;
478 static u16 ft_get_tag(struct se_portal_group *se_tpg)
480 struct ft_tpg *tpg = se_tpg->se_tpg_fabric_ptr;
483 * This tag is used when forming SCSI Name identifier in EVPD=1 0x83
484 * to represent the SCSI Target Port.
486 return tpg->index;
489 static u32 ft_get_default_depth(struct se_portal_group *se_tpg)
491 return 1;
494 static int ft_check_false(struct se_portal_group *se_tpg)
496 return 0;
499 static void ft_set_default_node_attr(struct se_node_acl *se_nacl)
503 static u16 ft_get_fabric_sense_len(void)
505 return 0;
508 static u16 ft_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_len)
510 return 0;
513 static u32 ft_tpg_get_inst_index(struct se_portal_group *se_tpg)
515 struct ft_tpg *tpg = se_tpg->se_tpg_fabric_ptr;
517 return tpg->index;
520 static struct target_core_fabric_ops ft_fabric_ops = {
521 .get_fabric_name = ft_get_fabric_name,
522 .get_fabric_proto_ident = fc_get_fabric_proto_ident,
523 .tpg_get_wwn = ft_get_fabric_wwn,
524 .tpg_get_tag = ft_get_tag,
525 .tpg_get_default_depth = ft_get_default_depth,
526 .tpg_get_pr_transport_id = fc_get_pr_transport_id,
527 .tpg_get_pr_transport_id_len = fc_get_pr_transport_id_len,
528 .tpg_parse_pr_out_transport_id = fc_parse_pr_out_transport_id,
529 .tpg_check_demo_mode = ft_check_false,
530 .tpg_check_demo_mode_cache = ft_check_false,
531 .tpg_check_demo_mode_write_protect = ft_check_false,
532 .tpg_check_prod_mode_write_protect = ft_check_false,
533 .tpg_alloc_fabric_acl = ft_tpg_alloc_fabric_acl,
534 .tpg_release_fabric_acl = ft_tpg_release_fabric_acl,
535 .tpg_get_inst_index = ft_tpg_get_inst_index,
536 .check_stop_free = ft_check_stop_free,
537 .release_cmd = ft_release_cmd,
538 .shutdown_session = ft_sess_shutdown,
539 .close_session = ft_sess_close,
540 .stop_session = ft_sess_stop,
541 .fall_back_to_erl0 = ft_sess_set_erl0,
542 .sess_logged_in = ft_sess_logged_in,
543 .sess_get_index = ft_sess_get_index,
544 .sess_get_initiator_sid = NULL,
545 .write_pending = ft_write_pending,
546 .write_pending_status = ft_write_pending_status,
547 .set_default_node_attributes = ft_set_default_node_attr,
548 .get_task_tag = ft_get_task_tag,
549 .get_cmd_state = ft_get_cmd_state,
550 .queue_data_in = ft_queue_data_in,
551 .queue_status = ft_queue_status,
552 .queue_tm_rsp = ft_queue_tm_resp,
553 .get_fabric_sense_len = ft_get_fabric_sense_len,
554 .set_fabric_sense_len = ft_set_fabric_sense_len,
555 .is_state_remove = ft_is_state_remove,
557 * Setup function pointers for generic logic in
558 * target_core_fabric_configfs.c
560 .fabric_make_wwn = &ft_add_lport,
561 .fabric_drop_wwn = &ft_del_lport,
562 .fabric_make_tpg = &ft_add_tpg,
563 .fabric_drop_tpg = &ft_del_tpg,
564 .fabric_post_link = NULL,
565 .fabric_pre_unlink = NULL,
566 .fabric_make_np = NULL,
567 .fabric_drop_np = NULL,
568 .fabric_make_nodeacl = &ft_add_acl,
569 .fabric_drop_nodeacl = &ft_del_acl,
572 int ft_register_configfs(void)
574 struct target_fabric_configfs *fabric;
575 int ret;
578 * Register the top level struct config_item_type with TCM core
580 fabric = target_fabric_configfs_init(THIS_MODULE, "fc");
581 if (IS_ERR(fabric)) {
582 pr_err("%s: target_fabric_configfs_init() failed!\n",
583 __func__);
584 return PTR_ERR(fabric);
586 fabric->tf_ops = ft_fabric_ops;
588 /* Allowing support for task_sg_chaining */
589 fabric->tf_ops.task_sg_chaining = 1;
592 * Setup default attribute lists for various fabric->tf_cit_tmpl
594 TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = ft_wwn_attrs;
595 TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = NULL;
596 TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
597 TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
598 TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
599 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_base_cit.ct_attrs =
600 ft_nacl_base_attrs;
601 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;
602 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_auth_cit.ct_attrs = NULL;
603 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_param_cit.ct_attrs = NULL;
605 * register the fabric for use within TCM
607 ret = target_fabric_configfs_register(fabric);
608 if (ret < 0) {
609 pr_debug("target_fabric_configfs_register() for"
610 " FC Target failed!\n");
611 target_fabric_configfs_free(fabric);
612 return -1;
616 * Setup our local pointer to *fabric.
618 ft_configfs = fabric;
619 return 0;
622 void ft_deregister_configfs(void)
624 if (!ft_configfs)
625 return;
626 target_fabric_configfs_deregister(ft_configfs);
627 ft_configfs = NULL;
630 static struct notifier_block ft_notifier = {
631 .notifier_call = ft_lport_notify
634 static int __init ft_init(void)
636 if (ft_register_configfs())
637 return -1;
638 if (fc_fc4_register_provider(FC_TYPE_FCP, &ft_prov)) {
639 ft_deregister_configfs();
640 return -1;
642 blocking_notifier_chain_register(&fc_lport_notifier_head, &ft_notifier);
643 fc_lport_iterate(ft_lport_add, NULL);
644 return 0;
647 static void __exit ft_exit(void)
649 blocking_notifier_chain_unregister(&fc_lport_notifier_head,
650 &ft_notifier);
651 fc_fc4_deregister_provider(FC_TYPE_FCP, &ft_prov);
652 fc_lport_iterate(ft_lport_del, NULL);
653 ft_deregister_configfs();
654 synchronize_rcu();
657 MODULE_DESCRIPTION("FC TCM fabric driver " FT_VERSION);
658 MODULE_LICENSE("GPL");
659 module_init(ft_init);
660 module_exit(ft_exit);