target: Drop unused legacy target_core_fabric_ops API callers
[linux-2.6.git] / drivers / target / tcm_fc / tfc_conf.c
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 struct target_fabric_configfs *ft_configfs;
52
53 LIST_HEAD(ft_lport_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 struct se_node_acl *ft_add_acl(
202         struct se_portal_group *se_tpg,
203         struct config_group *group,
204         const char *name)
205 {
206         struct ft_node_acl *acl;
207         struct ft_tpg *tpg;
208         u64 wwpn;
209         u32 q_depth;
210
211         pr_debug("add acl %s\n", name);
212         tpg = container_of(se_tpg, struct ft_tpg, se_tpg);
213
214         if (ft_parse_wwn(name, &wwpn, 1) < 0)
215                 return ERR_PTR(-EINVAL);
216
217         acl = kzalloc(sizeof(struct ft_node_acl), GFP_KERNEL);
218         if (!acl)
219                 return ERR_PTR(-ENOMEM);
220         acl->node_auth.port_name = wwpn;
221
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);
225 }
226
227 static void ft_del_acl(struct se_node_acl *se_acl)
228 {
229         struct se_portal_group *se_tpg = se_acl->se_tpg;
230         struct ft_tpg *tpg;
231         struct ft_node_acl *acl = container_of(se_acl,
232                                 struct ft_node_acl, se_node_acl);
233
234         pr_debug("del acl %s\n",
235                 config_item_name(&se_acl->acl_group.cg_item));
236
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);
240
241         core_tpg_del_initiator_node_acl(&tpg->se_tpg, se_acl, 1);
242         kfree(acl);
243 }
244
245 struct ft_node_acl *ft_acl_get(struct ft_tpg *tpg, struct fc_rport_priv *rdata)
246 {
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;
251
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);
261                         found = acl;
262                         /* XXX need to hold onto ACL */
263                         break;
264                 }
265         }
266         spin_unlock_irq(&se_tpg->acl_node_lock);
267         return found;
268 }
269
270 struct se_node_acl *ft_tpg_alloc_fabric_acl(struct se_portal_group *se_tpg)
271 {
272         struct ft_node_acl *acl;
273
274         acl = kzalloc(sizeof(*acl), GFP_KERNEL);
275         if (!acl) {
276                 pr_err("Unable to allocate struct ft_node_acl\n");
277                 return NULL;
278         }
279         pr_debug("acl %p\n", acl);
280         return &acl->se_node_acl;
281 }
282
283 static void ft_tpg_release_fabric_acl(struct se_portal_group *se_tpg,
284                                       struct se_node_acl *se_acl)
285 {
286         struct ft_node_acl *acl = container_of(se_acl,
287                                 struct ft_node_acl, se_node_acl);
288
289         pr_debug("acl %p\n", acl);
290         kfree(acl);
291 }
292
293 /*
294  * local_port port_group (tpg) ops.
295  */
296 static struct se_portal_group *ft_add_tpg(
297         struct se_wwn *wwn,
298         struct config_group *group,
299         const char *name)
300 {
301         struct ft_lport_acl *lacl;
302         struct ft_tpg *tpg;
303         unsigned long index;
304         int ret;
305
306         pr_debug("tcm_fc: add tpg %s\n", name);
307
308         /*
309          * Name must be "tpgt_" followed by the index.
310          */
311         if (strstr(name, "tpgt_") != name)
312                 return NULL;
313         if (strict_strtoul(name + 5, 10, &index) || index > UINT_MAX)
314                 return NULL;
315
316         lacl = container_of(wwn, struct ft_lport_acl, fc_lport_wwn);
317         tpg = kzalloc(sizeof(*tpg), GFP_KERNEL);
318         if (!tpg)
319                 return NULL;
320         tpg->index = index;
321         tpg->lport_acl = lacl;
322         INIT_LIST_HEAD(&tpg->lun_list);
323
324         ret = core_tpg_register(&ft_configfs->tf_ops, wwn, &tpg->se_tpg,
325                                 tpg, TRANSPORT_TPG_TYPE_NORMAL);
326         if (ret < 0) {
327                 kfree(tpg);
328                 return NULL;
329         }
330
331         tpg->workqueue = alloc_workqueue("tcm_fc", 0, 1);
332         if (!tpg->workqueue) {
333                 kfree(tpg);
334                 return NULL;
335         }
336
337         mutex_lock(&ft_lport_lock);
338         list_add_tail(&tpg->list, &lacl->tpg_list);
339         mutex_unlock(&ft_lport_lock);
340
341         return &tpg->se_tpg;
342 }
343
344 static void ft_del_tpg(struct se_portal_group *se_tpg)
345 {
346         struct ft_tpg *tpg = container_of(se_tpg, struct ft_tpg, se_tpg);
347
348         pr_debug("del tpg %s\n",
349                     config_item_name(&tpg->se_tpg.tpg_group.cg_item));
350
351         destroy_workqueue(tpg->workqueue);
352
353         /* Wait for sessions to be freed thru RCU, for BUG_ON below */
354         synchronize_rcu();
355
356         mutex_lock(&ft_lport_lock);
357         list_del(&tpg->list);
358         if (tpg->tport) {
359                 tpg->tport->tpg = NULL;
360                 tpg->tport = NULL;
361         }
362         mutex_unlock(&ft_lport_lock);
363
364         core_tpg_deregister(se_tpg);
365         kfree(tpg);
366 }
367
368 /*
369  * Verify that an lport is configured to use the tcm_fc module, and return
370  * the target port group that should be used.
371  *
372  * The caller holds ft_lport_lock.
373  */
374 struct ft_tpg *ft_lport_find_tpg(struct fc_lport *lport)
375 {
376         struct ft_lport_acl *lacl;
377         struct ft_tpg *tpg;
378
379         list_for_each_entry(lacl, &ft_lport_list, list) {
380                 if (lacl->wwpn == lport->wwpn) {
381                         list_for_each_entry(tpg, &lacl->tpg_list, list)
382                                 return tpg; /* XXX for now return first entry */
383                         return NULL;
384                 }
385         }
386         return NULL;
387 }
388
389 /*
390  * target config instance ops.
391  */
392
393 /*
394  * Add lport to allowed config.
395  * The name is the WWPN in lower-case ASCII, colon-separated bytes.
396  */
397 static struct se_wwn *ft_add_lport(
398         struct target_fabric_configfs *tf,
399         struct config_group *group,
400         const char *name)
401 {
402         struct ft_lport_acl *lacl;
403         struct ft_lport_acl *old_lacl;
404         u64 wwpn;
405
406         pr_debug("add lport %s\n", name);
407         if (ft_parse_wwn(name, &wwpn, 1) < 0)
408                 return NULL;
409         lacl = kzalloc(sizeof(*lacl), GFP_KERNEL);
410         if (!lacl)
411                 return NULL;
412         lacl->wwpn = wwpn;
413         INIT_LIST_HEAD(&lacl->tpg_list);
414
415         mutex_lock(&ft_lport_lock);
416         list_for_each_entry(old_lacl, &ft_lport_list, list) {
417                 if (old_lacl->wwpn == wwpn) {
418                         mutex_unlock(&ft_lport_lock);
419                         kfree(lacl);
420                         return NULL;
421                 }
422         }
423         list_add_tail(&lacl->list, &ft_lport_list);
424         ft_format_wwn(lacl->name, sizeof(lacl->name), wwpn);
425         mutex_unlock(&ft_lport_lock);
426
427         return &lacl->fc_lport_wwn;
428 }
429
430 static void ft_del_lport(struct se_wwn *wwn)
431 {
432         struct ft_lport_acl *lacl = container_of(wwn,
433                                 struct ft_lport_acl, fc_lport_wwn);
434
435         pr_debug("del lport %s\n", lacl->name);
436         mutex_lock(&ft_lport_lock);
437         list_del(&lacl->list);
438         mutex_unlock(&ft_lport_lock);
439
440         kfree(lacl);
441 }
442
443 static ssize_t ft_wwn_show_attr_version(
444         struct target_fabric_configfs *tf,
445         char *page)
446 {
447         return sprintf(page, "TCM FC " FT_VERSION " on %s/%s on "
448                 ""UTS_RELEASE"\n",  utsname()->sysname, utsname()->machine);
449 }
450
451 TF_WWN_ATTR_RO(ft, version);
452
453 static struct configfs_attribute *ft_wwn_attrs[] = {
454         &ft_wwn_version.attr,
455         NULL,
456 };
457
458 static char *ft_get_fabric_name(void)
459 {
460         return "fc";
461 }
462
463 static char *ft_get_fabric_wwn(struct se_portal_group *se_tpg)
464 {
465         struct ft_tpg *tpg = se_tpg->se_tpg_fabric_ptr;
466
467         return tpg->lport_acl->name;
468 }
469
470 static u16 ft_get_tag(struct se_portal_group *se_tpg)
471 {
472         struct ft_tpg *tpg = se_tpg->se_tpg_fabric_ptr;
473
474         /*
475          * This tag is used when forming SCSI Name identifier in EVPD=1 0x83
476          * to represent the SCSI Target Port.
477          */
478         return tpg->index;
479 }
480
481 static u32 ft_get_default_depth(struct se_portal_group *se_tpg)
482 {
483         return 1;
484 }
485
486 static int ft_check_false(struct se_portal_group *se_tpg)
487 {
488         return 0;
489 }
490
491 static void ft_set_default_node_attr(struct se_node_acl *se_nacl)
492 {
493 }
494
495 static u16 ft_get_fabric_sense_len(void)
496 {
497         return 0;
498 }
499
500 static u16 ft_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_len)
501 {
502         return 0;
503 }
504
505 static u32 ft_tpg_get_inst_index(struct se_portal_group *se_tpg)
506 {
507         struct ft_tpg *tpg = se_tpg->se_tpg_fabric_ptr;
508
509         return tpg->index;
510 }
511
512 static struct target_core_fabric_ops ft_fabric_ops = {
513         .get_fabric_name =              ft_get_fabric_name,
514         .get_fabric_proto_ident =       fc_get_fabric_proto_ident,
515         .tpg_get_wwn =                  ft_get_fabric_wwn,
516         .tpg_get_tag =                  ft_get_tag,
517         .tpg_get_default_depth =        ft_get_default_depth,
518         .tpg_get_pr_transport_id =      fc_get_pr_transport_id,
519         .tpg_get_pr_transport_id_len =  fc_get_pr_transport_id_len,
520         .tpg_parse_pr_out_transport_id = fc_parse_pr_out_transport_id,
521         .tpg_check_demo_mode =          ft_check_false,
522         .tpg_check_demo_mode_cache =    ft_check_false,
523         .tpg_check_demo_mode_write_protect = ft_check_false,
524         .tpg_check_prod_mode_write_protect = ft_check_false,
525         .tpg_alloc_fabric_acl =         ft_tpg_alloc_fabric_acl,
526         .tpg_release_fabric_acl =       ft_tpg_release_fabric_acl,
527         .tpg_get_inst_index =           ft_tpg_get_inst_index,
528         .check_stop_free =              ft_check_stop_free,
529         .release_cmd =                  ft_release_cmd,
530         .shutdown_session =             ft_sess_shutdown,
531         .close_session =                ft_sess_close,
532         .sess_get_index =               ft_sess_get_index,
533         .sess_get_initiator_sid =       NULL,
534         .write_pending =                ft_write_pending,
535         .write_pending_status =         ft_write_pending_status,
536         .set_default_node_attributes =  ft_set_default_node_attr,
537         .get_task_tag =                 ft_get_task_tag,
538         .get_cmd_state =                ft_get_cmd_state,
539         .queue_data_in =                ft_queue_data_in,
540         .queue_status =                 ft_queue_status,
541         .queue_tm_rsp =                 ft_queue_tm_resp,
542         .get_fabric_sense_len =         ft_get_fabric_sense_len,
543         .set_fabric_sense_len =         ft_set_fabric_sense_len,
544         /*
545          * Setup function pointers for generic logic in
546          * target_core_fabric_configfs.c
547          */
548         .fabric_make_wwn =              &ft_add_lport,
549         .fabric_drop_wwn =              &ft_del_lport,
550         .fabric_make_tpg =              &ft_add_tpg,
551         .fabric_drop_tpg =              &ft_del_tpg,
552         .fabric_post_link =             NULL,
553         .fabric_pre_unlink =            NULL,
554         .fabric_make_np =               NULL,
555         .fabric_drop_np =               NULL,
556         .fabric_make_nodeacl =          &ft_add_acl,
557         .fabric_drop_nodeacl =          &ft_del_acl,
558 };
559
560 int ft_register_configfs(void)
561 {
562         struct target_fabric_configfs *fabric;
563         int ret;
564
565         /*
566          * Register the top level struct config_item_type with TCM core
567          */
568         fabric = target_fabric_configfs_init(THIS_MODULE, "fc");
569         if (IS_ERR(fabric)) {
570                 pr_err("%s: target_fabric_configfs_init() failed!\n",
571                        __func__);
572                 return PTR_ERR(fabric);
573         }
574         fabric->tf_ops = ft_fabric_ops;
575
576         /* Allowing support for task_sg_chaining */
577         fabric->tf_ops.task_sg_chaining = 1;
578
579         /*
580          * Setup default attribute lists for various fabric->tf_cit_tmpl
581          */
582         TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = ft_wwn_attrs;
583         TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = NULL;
584         TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
585         TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
586         TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
587         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_base_cit.ct_attrs =
588                                                     ft_nacl_base_attrs;
589         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;
590         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_auth_cit.ct_attrs = NULL;
591         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_param_cit.ct_attrs = NULL;
592         /*
593          * register the fabric for use within TCM
594          */
595         ret = target_fabric_configfs_register(fabric);
596         if (ret < 0) {
597                 pr_debug("target_fabric_configfs_register() for"
598                             " FC Target failed!\n");
599                 target_fabric_configfs_free(fabric);
600                 return -1;
601         }
602
603         /*
604          * Setup our local pointer to *fabric.
605          */
606         ft_configfs = fabric;
607         return 0;
608 }
609
610 void ft_deregister_configfs(void)
611 {
612         if (!ft_configfs)
613                 return;
614         target_fabric_configfs_deregister(ft_configfs);
615         ft_configfs = NULL;
616 }
617
618 static struct notifier_block ft_notifier = {
619         .notifier_call = ft_lport_notify
620 };
621
622 static int __init ft_init(void)
623 {
624         if (ft_register_configfs())
625                 return -1;
626         if (fc_fc4_register_provider(FC_TYPE_FCP, &ft_prov)) {
627                 ft_deregister_configfs();
628                 return -1;
629         }
630         blocking_notifier_chain_register(&fc_lport_notifier_head, &ft_notifier);
631         fc_lport_iterate(ft_lport_add, NULL);
632         return 0;
633 }
634
635 static void __exit ft_exit(void)
636 {
637         blocking_notifier_chain_unregister(&fc_lport_notifier_head,
638                                            &ft_notifier);
639         fc_fc4_deregister_provider(FC_TYPE_FCP, &ft_prov);
640         fc_lport_iterate(ft_lport_del, NULL);
641         ft_deregister_configfs();
642         synchronize_rcu();
643 }
644
645 MODULE_DESCRIPTION("FC TCM fabric driver " FT_VERSION);
646 MODULE_LICENSE("GPL");
647 module_init(ft_init);
648 module_exit(ft_exit);