2 # The TCM v4 multi-protocol fabric module generation script for drivers/target/$NEW_MOD
4 # Copyright (c) 2010 Rising Tide Systems
5 # Copyright (c) 2010 Linux-iSCSI.org
7 # Author: nab@kernel.org
10 import subprocess as sub
20 fabric_mod_init_port = ""
26 def tcm_mod_create_module_subdir(fabric_mod_dir_var):
28 if os.path.isdir(fabric_mod_dir_var) == True:
31 print "Creating fabric_mod_dir: " + fabric_mod_dir_var
32 ret = os.mkdir(fabric_mod_dir_var)
34 tcm_mod_err("Unable to mkdir " + fabric_mod_dir_var)
38 def tcm_mod_build_FC_include(fabric_mod_dir_var, fabric_mod_name):
39 global fabric_mod_port
40 global fabric_mod_init_port
43 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
44 print "Writing file: " + f
48 tcm_mod_err("Unable to open file: " + f)
50 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
51 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
53 buf += "struct " + fabric_mod_name + "_nacl {\n"
54 buf += " /* Binary World Wide unique Port Name for FC Initiator Nport */\n"
55 buf += " u64 nport_wwpn;\n"
56 buf += " /* ASCII formatted WWPN for FC Initiator Nport */\n"
57 buf += " char nport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
58 buf += " /* Returned by " + fabric_mod_name + "_make_nodeacl() */\n"
59 buf += " struct se_node_acl se_node_acl;\n"
62 buf += "struct " + fabric_mod_name + "_tpg {\n"
63 buf += " /* FC lport target portal group tag for TCM */\n"
64 buf += " u16 lport_tpgt;\n"
65 buf += " /* Pointer back to " + fabric_mod_name + "_lport */\n"
66 buf += " struct " + fabric_mod_name + "_lport *lport;\n"
67 buf += " /* Returned by " + fabric_mod_name + "_make_tpg() */\n"
68 buf += " struct se_portal_group se_tpg;\n"
71 buf += "struct " + fabric_mod_name + "_lport {\n"
72 buf += " /* SCSI protocol the lport is providing */\n"
73 buf += " u8 lport_proto_id;\n"
74 buf += " /* Binary World Wide unique Port Name for FC Target Lport */\n"
75 buf += " u64 lport_wwpn;\n"
76 buf += " /* ASCII formatted WWPN for FC Target Lport */\n"
77 buf += " char lport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
78 buf += " /* Returned by " + fabric_mod_name + "_make_lport() */\n"
79 buf += " struct se_wwn lport_wwn;\n"
84 tcm_mod_err("Unable to write f: " + f)
88 fabric_mod_port = "lport"
89 fabric_mod_init_port = "nport"
93 def tcm_mod_build_SAS_include(fabric_mod_dir_var, fabric_mod_name):
94 global fabric_mod_port
95 global fabric_mod_init_port
98 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
99 print "Writing file: " + f
103 tcm_mod_err("Unable to open file: " + f)
105 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
106 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
108 buf += "struct " + fabric_mod_name + "_nacl {\n"
109 buf += " /* Binary World Wide unique Port Name for SAS Initiator port */\n"
110 buf += " u64 iport_wwpn;\n"
111 buf += " /* ASCII formatted WWPN for Sas Initiator port */\n"
112 buf += " char iport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
113 buf += " /* Returned by " + fabric_mod_name + "_make_nodeacl() */\n"
114 buf += " struct se_node_acl se_node_acl;\n"
116 buf += "struct " + fabric_mod_name + "_tpg {\n"
117 buf += " /* SAS port target portal group tag for TCM */\n"
118 buf += " u16 tport_tpgt;\n"
119 buf += " /* Pointer back to " + fabric_mod_name + "_tport */\n"
120 buf += " struct " + fabric_mod_name + "_tport *tport;\n"
121 buf += " /* Returned by " + fabric_mod_name + "_make_tpg() */\n"
122 buf += " struct se_portal_group se_tpg;\n"
124 buf += "struct " + fabric_mod_name + "_tport {\n"
125 buf += " /* SCSI protocol the tport is providing */\n"
126 buf += " u8 tport_proto_id;\n"
127 buf += " /* Binary World Wide unique Port Name for SAS Target port */\n"
128 buf += " u64 tport_wwpn;\n"
129 buf += " /* ASCII formatted WWPN for SAS Target port */\n"
130 buf += " char tport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
131 buf += " /* Returned by " + fabric_mod_name + "_make_tport() */\n"
132 buf += " struct se_wwn tport_wwn;\n"
137 tcm_mod_err("Unable to write f: " + f)
141 fabric_mod_port = "tport"
142 fabric_mod_init_port = "iport"
146 def tcm_mod_build_iSCSI_include(fabric_mod_dir_var, fabric_mod_name):
147 global fabric_mod_port
148 global fabric_mod_init_port
151 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
152 print "Writing file: " + f
156 tcm_mod_err("Unable to open file: " + f)
158 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
159 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
161 buf += "struct " + fabric_mod_name + "_nacl {\n"
162 buf += " /* ASCII formatted InitiatorName */\n"
163 buf += " char iport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
164 buf += " /* Returned by " + fabric_mod_name + "_make_nodeacl() */\n"
165 buf += " struct se_node_acl se_node_acl;\n"
167 buf += "struct " + fabric_mod_name + "_tpg {\n"
168 buf += " /* iSCSI target portal group tag for TCM */\n"
169 buf += " u16 tport_tpgt;\n"
170 buf += " /* Pointer back to " + fabric_mod_name + "_tport */\n"
171 buf += " struct " + fabric_mod_name + "_tport *tport;\n"
172 buf += " /* Returned by " + fabric_mod_name + "_make_tpg() */\n"
173 buf += " struct se_portal_group se_tpg;\n"
175 buf += "struct " + fabric_mod_name + "_tport {\n"
176 buf += " /* SCSI protocol the tport is providing */\n"
177 buf += " u8 tport_proto_id;\n"
178 buf += " /* ASCII formatted TargetName for IQN */\n"
179 buf += " char tport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
180 buf += " /* Returned by " + fabric_mod_name + "_make_tport() */\n"
181 buf += " struct se_wwn tport_wwn;\n"
186 tcm_mod_err("Unable to write f: " + f)
190 fabric_mod_port = "tport"
191 fabric_mod_init_port = "iport"
195 def tcm_mod_build_base_includes(proto_ident, fabric_mod_dir_val, fabric_mod_name):
197 if proto_ident == "FC":
198 tcm_mod_build_FC_include(fabric_mod_dir_val, fabric_mod_name)
199 elif proto_ident == "SAS":
200 tcm_mod_build_SAS_include(fabric_mod_dir_val, fabric_mod_name)
201 elif proto_ident == "iSCSI":
202 tcm_mod_build_iSCSI_include(fabric_mod_dir_val, fabric_mod_name)
204 print "Unsupported proto_ident: " + proto_ident
209 def tcm_mod_build_configfs(proto_ident, fabric_mod_dir_var, fabric_mod_name):
212 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_configfs.c"
213 print "Writing file: " + f
217 tcm_mod_err("Unable to open file: " + f)
219 buf = "#include <linux/module.h>\n"
220 buf += "#include <linux/moduleparam.h>\n"
221 buf += "#include <linux/version.h>\n"
222 buf += "#include <generated/utsrelease.h>\n"
223 buf += "#include <linux/utsname.h>\n"
224 buf += "#include <linux/init.h>\n"
225 buf += "#include <linux/slab.h>\n"
226 buf += "#include <linux/kthread.h>\n"
227 buf += "#include <linux/types.h>\n"
228 buf += "#include <linux/string.h>\n"
229 buf += "#include <linux/configfs.h>\n"
230 buf += "#include <linux/ctype.h>\n"
231 buf += "#include <asm/unaligned.h>\n\n"
232 buf += "#include <target/target_core_base.h>\n"
233 buf += "#include <target/target_core_fabric.h>\n"
234 buf += "#include <target/target_core_fabric_configfs.h>\n"
235 buf += "#include <target/target_core_configfs.h>\n"
236 buf += "#include <target/configfs_macros.h>\n\n"
237 buf += "#include \"" + fabric_mod_name + "_base.h\"\n"
238 buf += "#include \"" + fabric_mod_name + "_fabric.h\"\n\n"
240 buf += "/* Local pointer to allocated TCM configfs fabric module */\n"
241 buf += "struct target_fabric_configfs *" + fabric_mod_name + "_fabric_configfs;\n\n"
243 buf += "static struct se_node_acl *" + fabric_mod_name + "_make_nodeacl(\n"
244 buf += " struct se_portal_group *se_tpg,\n"
245 buf += " struct config_group *group,\n"
246 buf += " const char *name)\n"
248 buf += " struct se_node_acl *se_nacl, *se_nacl_new;\n"
249 buf += " struct " + fabric_mod_name + "_nacl *nacl;\n"
251 if proto_ident == "FC" or proto_ident == "SAS":
252 buf += " u64 wwpn = 0;\n"
254 buf += " u32 nexus_depth;\n\n"
255 buf += " /* " + fabric_mod_name + "_parse_wwn(name, &wwpn, 1) < 0)\n"
256 buf += " return ERR_PTR(-EINVAL); */\n"
257 buf += " se_nacl_new = " + fabric_mod_name + "_alloc_fabric_acl(se_tpg);\n"
258 buf += " if (!se_nacl_new)\n"
259 buf += " return ERR_PTR(-ENOMEM);\n"
260 buf += "//#warning FIXME: Hardcoded nexus depth in " + fabric_mod_name + "_make_nodeacl()\n"
261 buf += " nexus_depth = 1;\n"
263 buf += " * se_nacl_new may be released by core_tpg_add_initiator_node_acl()\n"
264 buf += " * when converting a NodeACL from demo mode -> explict\n"
266 buf += " se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,\n"
267 buf += " name, nexus_depth);\n"
268 buf += " if (IS_ERR(se_nacl)) {\n"
269 buf += " " + fabric_mod_name + "_release_fabric_acl(se_tpg, se_nacl_new);\n"
270 buf += " return se_nacl;\n"
273 buf += " * Locate our struct " + fabric_mod_name + "_nacl and set the FC Nport WWPN\n"
275 buf += " nacl = container_of(se_nacl, struct " + fabric_mod_name + "_nacl, se_node_acl);\n"
277 if proto_ident == "FC" or proto_ident == "SAS":
278 buf += " nacl->" + fabric_mod_init_port + "_wwpn = wwpn;\n"
280 buf += " /* " + fabric_mod_name + "_format_wwn(&nacl->" + fabric_mod_init_port + "_name[0], " + fabric_mod_name.upper() + "_NAMELEN, wwpn); */\n\n"
281 buf += " return se_nacl;\n"
283 buf += "static void " + fabric_mod_name + "_drop_nodeacl(struct se_node_acl *se_acl)\n"
285 buf += " struct " + fabric_mod_name + "_nacl *nacl = container_of(se_acl,\n"
286 buf += " struct " + fabric_mod_name + "_nacl, se_node_acl);\n"
287 buf += " core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);\n"
288 buf += " kfree(nacl);\n"
291 buf += "static struct se_portal_group *" + fabric_mod_name + "_make_tpg(\n"
292 buf += " struct se_wwn *wwn,\n"
293 buf += " struct config_group *group,\n"
294 buf += " const char *name)\n"
296 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + "*" + fabric_mod_port + " = container_of(wwn,\n"
297 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + ", " + fabric_mod_port + "_wwn);\n\n"
298 buf += " struct " + fabric_mod_name + "_tpg *tpg;\n"
299 buf += " unsigned long tpgt;\n"
300 buf += " int ret;\n\n"
301 buf += " if (strstr(name, \"tpgt_\") != name)\n"
302 buf += " return ERR_PTR(-EINVAL);\n"
303 buf += " if (kstrtoul(name + 5, 10, &tpgt) || tpgt > UINT_MAX)\n"
304 buf += " return ERR_PTR(-EINVAL);\n\n"
305 buf += " tpg = kzalloc(sizeof(struct " + fabric_mod_name + "_tpg), GFP_KERNEL);\n"
306 buf += " if (!tpg) {\n"
307 buf += " printk(KERN_ERR \"Unable to allocate struct " + fabric_mod_name + "_tpg\");\n"
308 buf += " return ERR_PTR(-ENOMEM);\n"
310 buf += " tpg->" + fabric_mod_port + " = " + fabric_mod_port + ";\n"
311 buf += " tpg->" + fabric_mod_port + "_tpgt = tpgt;\n\n"
312 buf += " ret = core_tpg_register(&" + fabric_mod_name + "_fabric_configfs->tf_ops, wwn,\n"
313 buf += " &tpg->se_tpg, (void *)tpg,\n"
314 buf += " TRANSPORT_TPG_TYPE_NORMAL);\n"
315 buf += " if (ret < 0) {\n"
316 buf += " kfree(tpg);\n"
317 buf += " return NULL;\n"
319 buf += " return &tpg->se_tpg;\n"
321 buf += "static void " + fabric_mod_name + "_drop_tpg(struct se_portal_group *se_tpg)\n"
323 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
324 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n\n"
325 buf += " core_tpg_deregister(se_tpg);\n"
326 buf += " kfree(tpg);\n"
329 buf += "static struct se_wwn *" + fabric_mod_name + "_make_" + fabric_mod_port + "(\n"
330 buf += " struct target_fabric_configfs *tf,\n"
331 buf += " struct config_group *group,\n"
332 buf += " const char *name)\n"
334 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + ";\n"
336 if proto_ident == "FC" or proto_ident == "SAS":
337 buf += " u64 wwpn = 0;\n\n"
339 buf += " /* if (" + fabric_mod_name + "_parse_wwn(name, &wwpn, 1) < 0)\n"
340 buf += " return ERR_PTR(-EINVAL); */\n\n"
341 buf += " " + fabric_mod_port + " = kzalloc(sizeof(struct " + fabric_mod_name + "_" + fabric_mod_port + "), GFP_KERNEL);\n"
342 buf += " if (!" + fabric_mod_port + ") {\n"
343 buf += " printk(KERN_ERR \"Unable to allocate struct " + fabric_mod_name + "_" + fabric_mod_port + "\");\n"
344 buf += " return ERR_PTR(-ENOMEM);\n"
347 if proto_ident == "FC" or proto_ident == "SAS":
348 buf += " " + fabric_mod_port + "->" + fabric_mod_port + "_wwpn = wwpn;\n"
350 buf += " /* " + fabric_mod_name + "_format_wwn(&" + fabric_mod_port + "->" + fabric_mod_port + "_name[0], " + fabric_mod_name.upper() + "_NAMELEN, wwpn); */\n\n"
351 buf += " return &" + fabric_mod_port + "->" + fabric_mod_port + "_wwn;\n"
353 buf += "static void " + fabric_mod_name + "_drop_" + fabric_mod_port + "(struct se_wwn *wwn)\n"
355 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = container_of(wwn,\n"
356 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + ", " + fabric_mod_port + "_wwn);\n"
357 buf += " kfree(" + fabric_mod_port + ");\n"
359 buf += "static ssize_t " + fabric_mod_name + "_wwn_show_attr_version(\n"
360 buf += " struct target_fabric_configfs *tf,\n"
361 buf += " char *page)\n"
363 buf += " return sprintf(page, \"" + fabric_mod_name.upper() + " fabric module %s on %s/%s\"\n"
364 buf += " \"on \"UTS_RELEASE\"\\n\", " + fabric_mod_name.upper() + "_VERSION, utsname()->sysname,\n"
365 buf += " utsname()->machine);\n"
367 buf += "TF_WWN_ATTR_RO(" + fabric_mod_name + ", version);\n\n"
368 buf += "static struct configfs_attribute *" + fabric_mod_name + "_wwn_attrs[] = {\n"
369 buf += " &" + fabric_mod_name + "_wwn_version.attr,\n"
373 buf += "static struct target_core_fabric_ops " + fabric_mod_name + "_ops = {\n"
374 buf += " .get_fabric_name = " + fabric_mod_name + "_get_fabric_name,\n"
375 buf += " .get_fabric_proto_ident = " + fabric_mod_name + "_get_fabric_proto_ident,\n"
376 buf += " .tpg_get_wwn = " + fabric_mod_name + "_get_fabric_wwn,\n"
377 buf += " .tpg_get_tag = " + fabric_mod_name + "_get_tag,\n"
378 buf += " .tpg_get_default_depth = " + fabric_mod_name + "_get_default_depth,\n"
379 buf += " .tpg_get_pr_transport_id = " + fabric_mod_name + "_get_pr_transport_id,\n"
380 buf += " .tpg_get_pr_transport_id_len = " + fabric_mod_name + "_get_pr_transport_id_len,\n"
381 buf += " .tpg_parse_pr_out_transport_id = " + fabric_mod_name + "_parse_pr_out_transport_id,\n"
382 buf += " .tpg_check_demo_mode = " + fabric_mod_name + "_check_false,\n"
383 buf += " .tpg_check_demo_mode_cache = " + fabric_mod_name + "_check_true,\n"
384 buf += " .tpg_check_demo_mode_write_protect = " + fabric_mod_name + "_check_true,\n"
385 buf += " .tpg_check_prod_mode_write_protect = " + fabric_mod_name + "_check_false,\n"
386 buf += " .tpg_alloc_fabric_acl = " + fabric_mod_name + "_alloc_fabric_acl,\n"
387 buf += " .tpg_release_fabric_acl = " + fabric_mod_name + "_release_fabric_acl,\n"
388 buf += " .tpg_get_inst_index = " + fabric_mod_name + "_tpg_get_inst_index,\n"
389 buf += " .release_cmd = " + fabric_mod_name + "_release_cmd,\n"
390 buf += " .shutdown_session = " + fabric_mod_name + "_shutdown_session,\n"
391 buf += " .close_session = " + fabric_mod_name + "_close_session,\n"
392 buf += " .sess_get_index = " + fabric_mod_name + "_sess_get_index,\n"
393 buf += " .sess_get_initiator_sid = NULL,\n"
394 buf += " .write_pending = " + fabric_mod_name + "_write_pending,\n"
395 buf += " .write_pending_status = " + fabric_mod_name + "_write_pending_status,\n"
396 buf += " .set_default_node_attributes = " + fabric_mod_name + "_set_default_node_attrs,\n"
397 buf += " .get_task_tag = " + fabric_mod_name + "_get_task_tag,\n"
398 buf += " .get_cmd_state = " + fabric_mod_name + "_get_cmd_state,\n"
399 buf += " .queue_data_in = " + fabric_mod_name + "_queue_data_in,\n"
400 buf += " .queue_status = " + fabric_mod_name + "_queue_status,\n"
401 buf += " .queue_tm_rsp = " + fabric_mod_name + "_queue_tm_rsp,\n"
402 buf += " .aborted_task = " + fabric_mod_name + "_aborted_task,\n"
404 buf += " * Setup function pointers for generic logic in target_core_fabric_configfs.c\n"
406 buf += " .fabric_make_wwn = " + fabric_mod_name + "_make_" + fabric_mod_port + ",\n"
407 buf += " .fabric_drop_wwn = " + fabric_mod_name + "_drop_" + fabric_mod_port + ",\n"
408 buf += " .fabric_make_tpg = " + fabric_mod_name + "_make_tpg,\n"
409 buf += " .fabric_drop_tpg = " + fabric_mod_name + "_drop_tpg,\n"
410 buf += " .fabric_post_link = NULL,\n"
411 buf += " .fabric_pre_unlink = NULL,\n"
412 buf += " .fabric_make_np = NULL,\n"
413 buf += " .fabric_drop_np = NULL,\n"
414 buf += " .fabric_make_nodeacl = " + fabric_mod_name + "_make_nodeacl,\n"
415 buf += " .fabric_drop_nodeacl = " + fabric_mod_name + "_drop_nodeacl,\n"
418 buf += "static int " + fabric_mod_name + "_register_configfs(void)\n"
420 buf += " struct target_fabric_configfs *fabric;\n"
421 buf += " int ret;\n\n"
422 buf += " printk(KERN_INFO \"" + fabric_mod_name.upper() + " fabric module %s on %s/%s\"\n"
423 buf += " \" on \"UTS_RELEASE\"\\n\"," + fabric_mod_name.upper() + "_VERSION, utsname()->sysname,\n"
424 buf += " utsname()->machine);\n"
426 buf += " * Register the top level struct config_item_type with TCM core\n"
428 buf += " fabric = target_fabric_configfs_init(THIS_MODULE, \"" + fabric_mod_name + "\");\n"
429 buf += " if (IS_ERR(fabric)) {\n"
430 buf += " printk(KERN_ERR \"target_fabric_configfs_init() failed\\n\");\n"
431 buf += " return PTR_ERR(fabric);\n"
434 buf += " * Setup fabric->tf_ops from our local " + fabric_mod_name + "_ops\n"
436 buf += " fabric->tf_ops = " + fabric_mod_name + "_ops;\n"
438 buf += " * Setup default attribute lists for various fabric->tf_cit_tmpl\n"
440 buf += " fabric->tf_cit_tmpl.tfc_wwn_cit.ct_attrs = " + fabric_mod_name + "_wwn_attrs;\n"
441 buf += " fabric->tf_cit_tmpl.tfc_tpg_base_cit.ct_attrs = NULL;\n"
442 buf += " fabric->tf_cit_tmpl.tfc_tpg_attrib_cit.ct_attrs = NULL;\n"
443 buf += " fabric->tf_cit_tmpl.tfc_tpg_param_cit.ct_attrs = NULL;\n"
444 buf += " fabric->tf_cit_tmpl.tfc_tpg_np_base_cit.ct_attrs = NULL;\n"
445 buf += " fabric->tf_cit_tmpl.tfc_tpg_nacl_base_cit.ct_attrs = NULL;\n"
446 buf += " fabric->tf_cit_tmpl.tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;\n"
447 buf += " fabric->tf_cit_tmpl.tfc_tpg_nacl_auth_cit.ct_attrs = NULL;\n"
448 buf += " fabric->tf_cit_tmpl.tfc_tpg_nacl_param_cit.ct_attrs = NULL;\n"
450 buf += " * Register the fabric for use within TCM\n"
452 buf += " ret = target_fabric_configfs_register(fabric);\n"
453 buf += " if (ret < 0) {\n"
454 buf += " printk(KERN_ERR \"target_fabric_configfs_register() failed\"\n"
455 buf += " \" for " + fabric_mod_name.upper() + "\\n\");\n"
456 buf += " return ret;\n"
459 buf += " * Setup our local pointer to *fabric\n"
461 buf += " " + fabric_mod_name + "_fabric_configfs = fabric;\n"
462 buf += " printk(KERN_INFO \"" + fabric_mod_name.upper() + "[0] - Set fabric -> " + fabric_mod_name + "_fabric_configfs\\n\");\n"
463 buf += " return 0;\n"
465 buf += "static void __exit " + fabric_mod_name + "_deregister_configfs(void)\n"
467 buf += " if (!" + fabric_mod_name + "_fabric_configfs)\n"
468 buf += " return;\n\n"
469 buf += " target_fabric_configfs_deregister(" + fabric_mod_name + "_fabric_configfs);\n"
470 buf += " " + fabric_mod_name + "_fabric_configfs = NULL;\n"
471 buf += " printk(KERN_INFO \"" + fabric_mod_name.upper() + "[0] - Cleared " + fabric_mod_name + "_fabric_configfs\\n\");\n"
474 buf += "static int __init " + fabric_mod_name + "_init(void)\n"
476 buf += " int ret;\n\n"
477 buf += " ret = " + fabric_mod_name + "_register_configfs();\n"
478 buf += " if (ret < 0)\n"
479 buf += " return ret;\n\n"
480 buf += " return 0;\n"
482 buf += "static void __exit " + fabric_mod_name + "_exit(void)\n"
484 buf += " " + fabric_mod_name + "_deregister_configfs();\n"
487 buf += "MODULE_DESCRIPTION(\"" + fabric_mod_name.upper() + " series fabric driver\");\n"
488 buf += "MODULE_LICENSE(\"GPL\");\n"
489 buf += "module_init(" + fabric_mod_name + "_init);\n"
490 buf += "module_exit(" + fabric_mod_name + "_exit);\n"
494 tcm_mod_err("Unable to write f: " + f)
500 def tcm_mod_scan_fabric_ops(tcm_dir):
502 fabric_ops_api = tcm_dir + "include/target/target_core_fabric.h"
504 print "Using tcm_mod_scan_fabric_ops: " + fabric_ops_api
507 p = open(fabric_ops_api, 'r')
511 if process_fo == 0 and re.search('struct target_core_fabric_ops {', line):
518 # Search for function pointer
519 if not re.search('\(\*', line):
522 fabric_ops.append(line.rstrip())
526 # Search for function pointer
527 if not re.search('\(\*', line):
530 fabric_ops.append(line.rstrip())
535 def tcm_mod_dump_fabric_ops(proto_ident, fabric_mod_dir_var, fabric_mod_name):
539 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_fabric.c"
540 print "Writing file: " + f
544 tcm_mod_err("Unable to open file: " + f)
546 fi = fabric_mod_dir_var + "/" + fabric_mod_name + "_fabric.h"
547 print "Writing file: " + fi
551 tcm_mod_err("Unable to open file: " + fi)
553 buf = "#include <linux/slab.h>\n"
554 buf += "#include <linux/kthread.h>\n"
555 buf += "#include <linux/types.h>\n"
556 buf += "#include <linux/list.h>\n"
557 buf += "#include <linux/types.h>\n"
558 buf += "#include <linux/string.h>\n"
559 buf += "#include <linux/ctype.h>\n"
560 buf += "#include <asm/unaligned.h>\n"
561 buf += "#include <scsi/scsi.h>\n"
562 buf += "#include <scsi/scsi_host.h>\n"
563 buf += "#include <scsi/scsi_device.h>\n"
564 buf += "#include <scsi/scsi_cmnd.h>\n"
565 buf += "#include <scsi/libfc.h>\n\n"
566 buf += "#include <target/target_core_base.h>\n"
567 buf += "#include <target/target_core_fabric.h>\n"
568 buf += "#include <target/target_core_configfs.h>\n\n"
569 buf += "#include \"" + fabric_mod_name + "_base.h\"\n"
570 buf += "#include \"" + fabric_mod_name + "_fabric.h\"\n\n"
572 buf += "int " + fabric_mod_name + "_check_true(struct se_portal_group *se_tpg)\n"
574 buf += " return 1;\n"
576 bufi += "int " + fabric_mod_name + "_check_true(struct se_portal_group *);\n"
578 buf += "int " + fabric_mod_name + "_check_false(struct se_portal_group *se_tpg)\n"
580 buf += " return 0;\n"
582 bufi += "int " + fabric_mod_name + "_check_false(struct se_portal_group *);\n"
584 total_fabric_ops = len(fabric_ops)
587 while i < total_fabric_ops:
590 # print "fabric_ops: " + fo
592 if re.search('get_fabric_name', fo):
593 buf += "char *" + fabric_mod_name + "_get_fabric_name(void)\n"
595 buf += " return \"" + fabric_mod_name + "\";\n"
597 bufi += "char *" + fabric_mod_name + "_get_fabric_name(void);\n"
600 if re.search('get_fabric_proto_ident', fo):
601 buf += "u8 " + fabric_mod_name + "_get_fabric_proto_ident(struct se_portal_group *se_tpg)\n"
603 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
604 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
605 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
606 buf += " u8 proto_id;\n\n"
607 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
608 if proto_ident == "FC":
609 buf += " case SCSI_PROTOCOL_FCP:\n"
611 buf += " proto_id = fc_get_fabric_proto_ident(se_tpg);\n"
613 elif proto_ident == "SAS":
614 buf += " case SCSI_PROTOCOL_SAS:\n"
616 buf += " proto_id = sas_get_fabric_proto_ident(se_tpg);\n"
618 elif proto_ident == "iSCSI":
619 buf += " case SCSI_PROTOCOL_ISCSI:\n"
621 buf += " proto_id = iscsi_get_fabric_proto_ident(se_tpg);\n"
625 buf += " return proto_id;\n"
627 bufi += "u8 " + fabric_mod_name + "_get_fabric_proto_ident(struct se_portal_group *);\n"
629 if re.search('get_wwn', fo):
630 buf += "char *" + fabric_mod_name + "_get_fabric_wwn(struct se_portal_group *se_tpg)\n"
632 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
633 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
634 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n\n"
635 buf += " return &" + fabric_mod_port + "->" + fabric_mod_port + "_name[0];\n"
637 bufi += "char *" + fabric_mod_name + "_get_fabric_wwn(struct se_portal_group *);\n"
639 if re.search('get_tag', fo):
640 buf += "u16 " + fabric_mod_name + "_get_tag(struct se_portal_group *se_tpg)\n"
642 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
643 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
644 buf += " return tpg->" + fabric_mod_port + "_tpgt;\n"
646 bufi += "u16 " + fabric_mod_name + "_get_tag(struct se_portal_group *);\n"
648 if re.search('get_default_depth', fo):
649 buf += "u32 " + fabric_mod_name + "_get_default_depth(struct se_portal_group *se_tpg)\n"
651 buf += " return 1;\n"
653 bufi += "u32 " + fabric_mod_name + "_get_default_depth(struct se_portal_group *);\n"
655 if re.search('get_pr_transport_id\)\(', fo):
656 buf += "u32 " + fabric_mod_name + "_get_pr_transport_id(\n"
657 buf += " struct se_portal_group *se_tpg,\n"
658 buf += " struct se_node_acl *se_nacl,\n"
659 buf += " struct t10_pr_registration *pr_reg,\n"
660 buf += " int *format_code,\n"
661 buf += " unsigned char *buf)\n"
663 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
664 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
665 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
666 buf += " int ret = 0;\n\n"
667 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
668 if proto_ident == "FC":
669 buf += " case SCSI_PROTOCOL_FCP:\n"
671 buf += " ret = fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,\n"
672 buf += " format_code, buf);\n"
674 elif proto_ident == "SAS":
675 buf += " case SCSI_PROTOCOL_SAS:\n"
677 buf += " ret = sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,\n"
678 buf += " format_code, buf);\n"
680 elif proto_ident == "iSCSI":
681 buf += " case SCSI_PROTOCOL_ISCSI:\n"
683 buf += " ret = iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,\n"
684 buf += " format_code, buf);\n"
688 buf += " return ret;\n"
690 bufi += "u32 " + fabric_mod_name + "_get_pr_transport_id(struct se_portal_group *,\n"
691 bufi += " struct se_node_acl *, struct t10_pr_registration *,\n"
692 bufi += " int *, unsigned char *);\n"
694 if re.search('get_pr_transport_id_len\)\(', fo):
695 buf += "u32 " + fabric_mod_name + "_get_pr_transport_id_len(\n"
696 buf += " struct se_portal_group *se_tpg,\n"
697 buf += " struct se_node_acl *se_nacl,\n"
698 buf += " struct t10_pr_registration *pr_reg,\n"
699 buf += " int *format_code)\n"
701 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
702 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
703 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
704 buf += " int ret = 0;\n\n"
705 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
706 if proto_ident == "FC":
707 buf += " case SCSI_PROTOCOL_FCP:\n"
709 buf += " ret = fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,\n"
710 buf += " format_code);\n"
712 elif proto_ident == "SAS":
713 buf += " case SCSI_PROTOCOL_SAS:\n"
715 buf += " ret = sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,\n"
716 buf += " format_code);\n"
718 elif proto_ident == "iSCSI":
719 buf += " case SCSI_PROTOCOL_ISCSI:\n"
721 buf += " ret = iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,\n"
722 buf += " format_code);\n"
727 buf += " return ret;\n"
729 bufi += "u32 " + fabric_mod_name + "_get_pr_transport_id_len(struct se_portal_group *,\n"
730 bufi += " struct se_node_acl *, struct t10_pr_registration *,\n"
733 if re.search('parse_pr_out_transport_id\)\(', fo):
734 buf += "char *" + fabric_mod_name + "_parse_pr_out_transport_id(\n"
735 buf += " struct se_portal_group *se_tpg,\n"
736 buf += " const char *buf,\n"
737 buf += " u32 *out_tid_len,\n"
738 buf += " char **port_nexus_ptr)\n"
740 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
741 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
742 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
743 buf += " char *tid = NULL;\n\n"
744 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
745 if proto_ident == "FC":
746 buf += " case SCSI_PROTOCOL_FCP:\n"
748 buf += " tid = fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,\n"
749 buf += " port_nexus_ptr);\n"
750 elif proto_ident == "SAS":
751 buf += " case SCSI_PROTOCOL_SAS:\n"
753 buf += " tid = sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,\n"
754 buf += " port_nexus_ptr);\n"
755 elif proto_ident == "iSCSI":
756 buf += " case SCSI_PROTOCOL_ISCSI:\n"
758 buf += " tid = iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,\n"
759 buf += " port_nexus_ptr);\n"
762 buf += " return tid;\n"
764 bufi += "char *" + fabric_mod_name + "_parse_pr_out_transport_id(struct se_portal_group *,\n"
765 bufi += " const char *, u32 *, char **);\n"
767 if re.search('alloc_fabric_acl\)\(', fo):
768 buf += "struct se_node_acl *" + fabric_mod_name + "_alloc_fabric_acl(struct se_portal_group *se_tpg)\n"
770 buf += " struct " + fabric_mod_name + "_nacl *nacl;\n\n"
771 buf += " nacl = kzalloc(sizeof(struct " + fabric_mod_name + "_nacl), GFP_KERNEL);\n"
772 buf += " if (!nacl) {\n"
773 buf += " printk(KERN_ERR \"Unable to allocate struct " + fabric_mod_name + "_nacl\\n\");\n"
774 buf += " return NULL;\n"
776 buf += " return &nacl->se_node_acl;\n"
778 bufi += "struct se_node_acl *" + fabric_mod_name + "_alloc_fabric_acl(struct se_portal_group *);\n"
780 if re.search('release_fabric_acl\)\(', fo):
781 buf += "void " + fabric_mod_name + "_release_fabric_acl(\n"
782 buf += " struct se_portal_group *se_tpg,\n"
783 buf += " struct se_node_acl *se_nacl)\n"
785 buf += " struct " + fabric_mod_name + "_nacl *nacl = container_of(se_nacl,\n"
786 buf += " struct " + fabric_mod_name + "_nacl, se_node_acl);\n"
787 buf += " kfree(nacl);\n"
789 bufi += "void " + fabric_mod_name + "_release_fabric_acl(struct se_portal_group *,\n"
790 bufi += " struct se_node_acl *);\n"
792 if re.search('tpg_get_inst_index\)\(', fo):
793 buf += "u32 " + fabric_mod_name + "_tpg_get_inst_index(struct se_portal_group *se_tpg)\n"
795 buf += " return 1;\n"
797 bufi += "u32 " + fabric_mod_name + "_tpg_get_inst_index(struct se_portal_group *);\n"
799 if re.search('\*release_cmd\)\(', fo):
800 buf += "void " + fabric_mod_name + "_release_cmd(struct se_cmd *se_cmd)\n"
804 bufi += "void " + fabric_mod_name + "_release_cmd(struct se_cmd *);\n"
806 if re.search('shutdown_session\)\(', fo):
807 buf += "int " + fabric_mod_name + "_shutdown_session(struct se_session *se_sess)\n"
809 buf += " return 0;\n"
811 bufi += "int " + fabric_mod_name + "_shutdown_session(struct se_session *);\n"
813 if re.search('close_session\)\(', fo):
814 buf += "void " + fabric_mod_name + "_close_session(struct se_session *se_sess)\n"
818 bufi += "void " + fabric_mod_name + "_close_session(struct se_session *);\n"
820 if re.search('sess_get_index\)\(', fo):
821 buf += "u32 " + fabric_mod_name + "_sess_get_index(struct se_session *se_sess)\n"
823 buf += " return 0;\n"
825 bufi += "u32 " + fabric_mod_name + "_sess_get_index(struct se_session *);\n"
827 if re.search('write_pending\)\(', fo):
828 buf += "int " + fabric_mod_name + "_write_pending(struct se_cmd *se_cmd)\n"
830 buf += " return 0;\n"
832 bufi += "int " + fabric_mod_name + "_write_pending(struct se_cmd *);\n"
834 if re.search('write_pending_status\)\(', fo):
835 buf += "int " + fabric_mod_name + "_write_pending_status(struct se_cmd *se_cmd)\n"
837 buf += " return 0;\n"
839 bufi += "int " + fabric_mod_name + "_write_pending_status(struct se_cmd *);\n"
841 if re.search('set_default_node_attributes\)\(', fo):
842 buf += "void " + fabric_mod_name + "_set_default_node_attrs(struct se_node_acl *nacl)\n"
846 bufi += "void " + fabric_mod_name + "_set_default_node_attrs(struct se_node_acl *);\n"
848 if re.search('get_task_tag\)\(', fo):
849 buf += "u32 " + fabric_mod_name + "_get_task_tag(struct se_cmd *se_cmd)\n"
851 buf += " return 0;\n"
853 bufi += "u32 " + fabric_mod_name + "_get_task_tag(struct se_cmd *);\n"
855 if re.search('get_cmd_state\)\(', fo):
856 buf += "int " + fabric_mod_name + "_get_cmd_state(struct se_cmd *se_cmd)\n"
858 buf += " return 0;\n"
860 bufi += "int " + fabric_mod_name + "_get_cmd_state(struct se_cmd *);\n"
862 if re.search('queue_data_in\)\(', fo):
863 buf += "int " + fabric_mod_name + "_queue_data_in(struct se_cmd *se_cmd)\n"
865 buf += " return 0;\n"
867 bufi += "int " + fabric_mod_name + "_queue_data_in(struct se_cmd *);\n"
869 if re.search('queue_status\)\(', fo):
870 buf += "int " + fabric_mod_name + "_queue_status(struct se_cmd *se_cmd)\n"
872 buf += " return 0;\n"
874 bufi += "int " + fabric_mod_name + "_queue_status(struct se_cmd *);\n"
876 if re.search('queue_tm_rsp\)\(', fo):
877 buf += "void " + fabric_mod_name + "_queue_tm_rsp(struct se_cmd *se_cmd)\n"
881 bufi += "void " + fabric_mod_name + "_queue_tm_rsp(struct se_cmd *);\n"
883 if re.search('aborted_task\)\(', fo):
884 buf += "void " + fabric_mod_name + "_aborted_task(struct se_cmd *se_cmd)\n"
888 bufi += "void " + fabric_mod_name + "_aborted_task(struct se_cmd *);\n"
892 tcm_mod_err("Unable to write f: " + f)
898 tcm_mod_err("Unable to write fi: " + fi)
903 def tcm_mod_build_kbuild(fabric_mod_dir_var, fabric_mod_name):
906 f = fabric_mod_dir_var + "/Makefile"
907 print "Writing file: " + f
911 tcm_mod_err("Unable to open file: " + f)
913 buf += fabric_mod_name + "-objs := " + fabric_mod_name + "_fabric.o \\\n"
914 buf += " " + fabric_mod_name + "_configfs.o\n"
915 buf += "obj-$(CONFIG_" + fabric_mod_name.upper() + ") += " + fabric_mod_name + ".o\n"
919 tcm_mod_err("Unable to write f: " + f)
924 def tcm_mod_build_kconfig(fabric_mod_dir_var, fabric_mod_name):
927 f = fabric_mod_dir_var + "/Kconfig"
928 print "Writing file: " + f
932 tcm_mod_err("Unable to open file: " + f)
934 buf = "config " + fabric_mod_name.upper() + "\n"
935 buf += " tristate \"" + fabric_mod_name.upper() + " fabric module\"\n"
936 buf += " depends on TARGET_CORE && CONFIGFS_FS\n"
937 buf += " default n\n"
938 buf += " ---help---\n"
939 buf += " Say Y here to enable the " + fabric_mod_name.upper() + " fabric module\n"
943 tcm_mod_err("Unable to write f: " + f)
948 def tcm_mod_add_kbuild(tcm_dir, fabric_mod_name):
949 buf = "obj-$(CONFIG_" + fabric_mod_name.upper() + ") += " + fabric_mod_name.lower() + "/\n"
950 kbuild = tcm_dir + "/drivers/target/Makefile"
952 f = open(kbuild, 'a')
957 def tcm_mod_add_kconfig(tcm_dir, fabric_mod_name):
958 buf = "source \"drivers/target/" + fabric_mod_name.lower() + "/Kconfig\"\n"
959 kconfig = tcm_dir + "/drivers/target/Kconfig"
961 f = open(kconfig, 'a')
966 def main(modname, proto_ident):
968 # proto_ident = "SAS"
969 # proto_ident = "iSCSI"
971 tcm_dir = os.getcwd();
973 print "tcm_dir: " + tcm_dir
974 fabric_mod_name = modname
975 fabric_mod_dir = tcm_dir + "drivers/target/" + fabric_mod_name
976 print "Set fabric_mod_name: " + fabric_mod_name
977 print "Set fabric_mod_dir: " + fabric_mod_dir
978 print "Using proto_ident: " + proto_ident
980 if proto_ident != "FC" and proto_ident != "SAS" and proto_ident != "iSCSI":
981 print "Unsupported proto_ident: " + proto_ident
984 ret = tcm_mod_create_module_subdir(fabric_mod_dir)
986 print "tcm_mod_create_module_subdir() failed because module already exists!"
989 tcm_mod_build_base_includes(proto_ident, fabric_mod_dir, fabric_mod_name)
990 tcm_mod_scan_fabric_ops(tcm_dir)
991 tcm_mod_dump_fabric_ops(proto_ident, fabric_mod_dir, fabric_mod_name)
992 tcm_mod_build_configfs(proto_ident, fabric_mod_dir, fabric_mod_name)
993 tcm_mod_build_kbuild(fabric_mod_dir, fabric_mod_name)
994 tcm_mod_build_kconfig(fabric_mod_dir, fabric_mod_name)
996 input = raw_input("Would you like to add " + fabric_mod_name + " to drivers/target/Makefile..? [yes,no]: ")
997 if input == "yes" or input == "y":
998 tcm_mod_add_kbuild(tcm_dir, fabric_mod_name)
1000 input = raw_input("Would you like to add " + fabric_mod_name + " to drivers/target/Kconfig..? [yes,no]: ")
1001 if input == "yes" or input == "y":
1002 tcm_mod_add_kconfig(tcm_dir, fabric_mod_name)
1006 parser = optparse.OptionParser()
1007 parser.add_option('-m', '--modulename', help='Module name', dest='modname',
1008 action='store', nargs=1, type='string')
1009 parser.add_option('-p', '--protoident', help='Protocol Ident', dest='protoident',
1010 action='store', nargs=1, type='string')
1012 (opts, args) = parser.parse_args()
1014 mandatories = ['modname', 'protoident']
1015 for m in mandatories:
1016 if not opts.__dict__[m]:
1017 print "mandatory option is missing\n"
1021 if __name__ == "__main__":
1023 main(str(opts.modname), opts.protoident)