Loading...
1#!/usr/bin/python
2# The TCM v4 multi-protocol fabric module generation script for drivers/target/$NEW_MOD
3#
4# Copyright (c) 2010 Rising Tide Systems
5# Copyright (c) 2010 Linux-iSCSI.org
6#
7# Author: nab@kernel.org
8#
9import os, sys
10import subprocess as sub
11import string
12import re
13import optparse
14
15tcm_dir = ""
16
17fabric_ops = []
18fabric_mod_dir = ""
19fabric_mod_port = ""
20fabric_mod_init_port = ""
21
22def tcm_mod_err(msg):
23 print msg
24 sys.exit(1)
25
26def tcm_mod_create_module_subdir(fabric_mod_dir_var):
27
28 if os.path.isdir(fabric_mod_dir_var) == True:
29 return 1
30
31 print "Creating fabric_mod_dir: " + fabric_mod_dir_var
32 ret = os.mkdir(fabric_mod_dir_var)
33 if ret:
34 tcm_mod_err("Unable to mkdir " + fabric_mod_dir_var)
35
36 return
37
38def tcm_mod_build_FC_include(fabric_mod_dir_var, fabric_mod_name):
39 global fabric_mod_port
40 global fabric_mod_init_port
41 buf = ""
42
43 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
44 print "Writing file: " + f
45
46 p = open(f, 'w');
47 if not p:
48 tcm_mod_err("Unable to open file: " + f)
49
50 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
51 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
52 buf += "\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"
60 buf += "};\n"
61 buf += "\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"
69 buf += "};\n"
70 buf += "\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"
80 buf += "};\n"
81
82 ret = p.write(buf)
83 if ret:
84 tcm_mod_err("Unable to write f: " + f)
85
86 p.close()
87
88 fabric_mod_port = "lport"
89 fabric_mod_init_port = "nport"
90
91 return
92
93def tcm_mod_build_SAS_include(fabric_mod_dir_var, fabric_mod_name):
94 global fabric_mod_port
95 global fabric_mod_init_port
96 buf = ""
97
98 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
99 print "Writing file: " + f
100
101 p = open(f, 'w');
102 if not p:
103 tcm_mod_err("Unable to open file: " + f)
104
105 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
106 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
107 buf += "\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"
115 buf += "};\n\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"
123 buf += "};\n\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"
133 buf += "};\n"
134
135 ret = p.write(buf)
136 if ret:
137 tcm_mod_err("Unable to write f: " + f)
138
139 p.close()
140
141 fabric_mod_port = "tport"
142 fabric_mod_init_port = "iport"
143
144 return
145
146def tcm_mod_build_iSCSI_include(fabric_mod_dir_var, fabric_mod_name):
147 global fabric_mod_port
148 global fabric_mod_init_port
149 buf = ""
150
151 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
152 print "Writing file: " + f
153
154 p = open(f, 'w');
155 if not p:
156 tcm_mod_err("Unable to open file: " + f)
157
158 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
159 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
160 buf += "\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"
166 buf += "};\n\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"
174 buf += "};\n\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"
182 buf += "};\n"
183
184 ret = p.write(buf)
185 if ret:
186 tcm_mod_err("Unable to write f: " + f)
187
188 p.close()
189
190 fabric_mod_port = "tport"
191 fabric_mod_init_port = "iport"
192
193 return
194
195def tcm_mod_build_base_includes(proto_ident, fabric_mod_dir_val, fabric_mod_name):
196
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)
203 else:
204 print "Unsupported proto_ident: " + proto_ident
205 sys.exit(1)
206
207 return
208
209def tcm_mod_build_configfs(proto_ident, fabric_mod_dir_var, fabric_mod_name):
210 buf = ""
211
212 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_configfs.c"
213 print "Writing file: " + f
214
215 p = open(f, 'w');
216 if not p:
217 tcm_mod_err("Unable to open file: " + f)
218
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_transport.h>\n"
234 buf += "#include <target/target_core_fabric_ops.h>\n"
235 buf += "#include <target/target_core_fabric_configfs.h>\n"
236 buf += "#include <target/target_core_fabric_lib.h>\n"
237 buf += "#include <target/target_core_device.h>\n"
238 buf += "#include <target/target_core_tpg.h>\n"
239 buf += "#include <target/target_core_configfs.h>\n"
240 buf += "#include <target/target_core_base.h>\n"
241 buf += "#include <target/configfs_macros.h>\n\n"
242 buf += "#include \"" + fabric_mod_name + "_base.h\"\n"
243 buf += "#include \"" + fabric_mod_name + "_fabric.h\"\n\n"
244
245 buf += "/* Local pointer to allocated TCM configfs fabric module */\n"
246 buf += "struct target_fabric_configfs *" + fabric_mod_name + "_fabric_configfs;\n\n"
247
248 buf += "static struct se_node_acl *" + fabric_mod_name + "_make_nodeacl(\n"
249 buf += " struct se_portal_group *se_tpg,\n"
250 buf += " struct config_group *group,\n"
251 buf += " const char *name)\n"
252 buf += "{\n"
253 buf += " struct se_node_acl *se_nacl, *se_nacl_new;\n"
254 buf += " struct " + fabric_mod_name + "_nacl *nacl;\n"
255
256 if proto_ident == "FC" or proto_ident == "SAS":
257 buf += " u64 wwpn = 0;\n"
258
259 buf += " u32 nexus_depth;\n\n"
260 buf += " /* " + fabric_mod_name + "_parse_wwn(name, &wwpn, 1) < 0)\n"
261 buf += " return ERR_PTR(-EINVAL); */\n"
262 buf += " se_nacl_new = " + fabric_mod_name + "_alloc_fabric_acl(se_tpg);\n"
263 buf += " if (!(se_nacl_new))\n"
264 buf += " return ERR_PTR(-ENOMEM);\n"
265 buf += "//#warning FIXME: Hardcoded nexus depth in " + fabric_mod_name + "_make_nodeacl()\n"
266 buf += " nexus_depth = 1;\n"
267 buf += " /*\n"
268 buf += " * se_nacl_new may be released by core_tpg_add_initiator_node_acl()\n"
269 buf += " * when converting a NodeACL from demo mode -> explict\n"
270 buf += " */\n"
271 buf += " se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,\n"
272 buf += " name, nexus_depth);\n"
273 buf += " if (IS_ERR(se_nacl)) {\n"
274 buf += " " + fabric_mod_name + "_release_fabric_acl(se_tpg, se_nacl_new);\n"
275 buf += " return se_nacl;\n"
276 buf += " }\n"
277 buf += " /*\n"
278 buf += " * Locate our struct " + fabric_mod_name + "_nacl and set the FC Nport WWPN\n"
279 buf += " */\n"
280 buf += " nacl = container_of(se_nacl, struct " + fabric_mod_name + "_nacl, se_node_acl);\n"
281
282 if proto_ident == "FC" or proto_ident == "SAS":
283 buf += " nacl->" + fabric_mod_init_port + "_wwpn = wwpn;\n"
284
285 buf += " /* " + fabric_mod_name + "_format_wwn(&nacl->" + fabric_mod_init_port + "_name[0], " + fabric_mod_name.upper() + "_NAMELEN, wwpn); */\n\n"
286 buf += " return se_nacl;\n"
287 buf += "}\n\n"
288 buf += "static void " + fabric_mod_name + "_drop_nodeacl(struct se_node_acl *se_acl)\n"
289 buf += "{\n"
290 buf += " struct " + fabric_mod_name + "_nacl *nacl = container_of(se_acl,\n"
291 buf += " struct " + fabric_mod_name + "_nacl, se_node_acl);\n"
292 buf += " core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);\n"
293 buf += " kfree(nacl);\n"
294 buf += "}\n\n"
295
296 buf += "static struct se_portal_group *" + fabric_mod_name + "_make_tpg(\n"
297 buf += " struct se_wwn *wwn,\n"
298 buf += " struct config_group *group,\n"
299 buf += " const char *name)\n"
300 buf += "{\n"
301 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + "*" + fabric_mod_port + " = container_of(wwn,\n"
302 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + ", " + fabric_mod_port + "_wwn);\n\n"
303 buf += " struct " + fabric_mod_name + "_tpg *tpg;\n"
304 buf += " unsigned long tpgt;\n"
305 buf += " int ret;\n\n"
306 buf += " if (strstr(name, \"tpgt_\") != name)\n"
307 buf += " return ERR_PTR(-EINVAL);\n"
308 buf += " if (strict_strtoul(name + 5, 10, &tpgt) || tpgt > UINT_MAX)\n"
309 buf += " return ERR_PTR(-EINVAL);\n\n"
310 buf += " tpg = kzalloc(sizeof(struct " + fabric_mod_name + "_tpg), GFP_KERNEL);\n"
311 buf += " if (!(tpg)) {\n"
312 buf += " printk(KERN_ERR \"Unable to allocate struct " + fabric_mod_name + "_tpg\");\n"
313 buf += " return ERR_PTR(-ENOMEM);\n"
314 buf += " }\n"
315 buf += " tpg->" + fabric_mod_port + " = " + fabric_mod_port + ";\n"
316 buf += " tpg->" + fabric_mod_port + "_tpgt = tpgt;\n\n"
317 buf += " ret = core_tpg_register(&" + fabric_mod_name + "_fabric_configfs->tf_ops, wwn,\n"
318 buf += " &tpg->se_tpg, (void *)tpg,\n"
319 buf += " TRANSPORT_TPG_TYPE_NORMAL);\n"
320 buf += " if (ret < 0) {\n"
321 buf += " kfree(tpg);\n"
322 buf += " return NULL;\n"
323 buf += " }\n"
324 buf += " return &tpg->se_tpg;\n"
325 buf += "}\n\n"
326 buf += "static void " + fabric_mod_name + "_drop_tpg(struct se_portal_group *se_tpg)\n"
327 buf += "{\n"
328 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
329 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n\n"
330 buf += " core_tpg_deregister(se_tpg);\n"
331 buf += " kfree(tpg);\n"
332 buf += "}\n\n"
333
334 buf += "static struct se_wwn *" + fabric_mod_name + "_make_" + fabric_mod_port + "(\n"
335 buf += " struct target_fabric_configfs *tf,\n"
336 buf += " struct config_group *group,\n"
337 buf += " const char *name)\n"
338 buf += "{\n"
339 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + ";\n"
340
341 if proto_ident == "FC" or proto_ident == "SAS":
342 buf += " u64 wwpn = 0;\n\n"
343
344 buf += " /* if (" + fabric_mod_name + "_parse_wwn(name, &wwpn, 1) < 0)\n"
345 buf += " return ERR_PTR(-EINVAL); */\n\n"
346 buf += " " + fabric_mod_port + " = kzalloc(sizeof(struct " + fabric_mod_name + "_" + fabric_mod_port + "), GFP_KERNEL);\n"
347 buf += " if (!(" + fabric_mod_port + ")) {\n"
348 buf += " printk(KERN_ERR \"Unable to allocate struct " + fabric_mod_name + "_" + fabric_mod_port + "\");\n"
349 buf += " return ERR_PTR(-ENOMEM);\n"
350 buf += " }\n"
351
352 if proto_ident == "FC" or proto_ident == "SAS":
353 buf += " " + fabric_mod_port + "->" + fabric_mod_port + "_wwpn = wwpn;\n"
354
355 buf += " /* " + fabric_mod_name + "_format_wwn(&" + fabric_mod_port + "->" + fabric_mod_port + "_name[0], " + fabric_mod_name.upper() + "__NAMELEN, wwpn); */\n\n"
356 buf += " return &" + fabric_mod_port + "->" + fabric_mod_port + "_wwn;\n"
357 buf += "}\n\n"
358 buf += "static void " + fabric_mod_name + "_drop_" + fabric_mod_port + "(struct se_wwn *wwn)\n"
359 buf += "{\n"
360 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = container_of(wwn,\n"
361 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + ", " + fabric_mod_port + "_wwn);\n"
362 buf += " kfree(" + fabric_mod_port + ");\n"
363 buf += "}\n\n"
364 buf += "static ssize_t " + fabric_mod_name + "_wwn_show_attr_version(\n"
365 buf += " struct target_fabric_configfs *tf,\n"
366 buf += " char *page)\n"
367 buf += "{\n"
368 buf += " return sprintf(page, \"" + fabric_mod_name.upper() + " fabric module %s on %s/%s\"\n"
369 buf += " \"on \"UTS_RELEASE\"\\n\", " + fabric_mod_name.upper() + "_VERSION, utsname()->sysname,\n"
370 buf += " utsname()->machine);\n"
371 buf += "}\n\n"
372 buf += "TF_WWN_ATTR_RO(" + fabric_mod_name + ", version);\n\n"
373 buf += "static struct configfs_attribute *" + fabric_mod_name + "_wwn_attrs[] = {\n"
374 buf += " &" + fabric_mod_name + "_wwn_version.attr,\n"
375 buf += " NULL,\n"
376 buf += "};\n\n"
377
378 buf += "static struct target_core_fabric_ops " + fabric_mod_name + "_ops = {\n"
379 buf += " .get_fabric_name = " + fabric_mod_name + "_get_fabric_name,\n"
380 buf += " .get_fabric_proto_ident = " + fabric_mod_name + "_get_fabric_proto_ident,\n"
381 buf += " .tpg_get_wwn = " + fabric_mod_name + "_get_fabric_wwn,\n"
382 buf += " .tpg_get_tag = " + fabric_mod_name + "_get_tag,\n"
383 buf += " .tpg_get_default_depth = " + fabric_mod_name + "_get_default_depth,\n"
384 buf += " .tpg_get_pr_transport_id = " + fabric_mod_name + "_get_pr_transport_id,\n"
385 buf += " .tpg_get_pr_transport_id_len = " + fabric_mod_name + "_get_pr_transport_id_len,\n"
386 buf += " .tpg_parse_pr_out_transport_id = " + fabric_mod_name + "_parse_pr_out_transport_id,\n"
387 buf += " .tpg_check_demo_mode = " + fabric_mod_name + "_check_false,\n"
388 buf += " .tpg_check_demo_mode_cache = " + fabric_mod_name + "_check_true,\n"
389 buf += " .tpg_check_demo_mode_write_protect = " + fabric_mod_name + "_check_true,\n"
390 buf += " .tpg_check_prod_mode_write_protect = " + fabric_mod_name + "_check_false,\n"
391 buf += " .tpg_alloc_fabric_acl = " + fabric_mod_name + "_alloc_fabric_acl,\n"
392 buf += " .tpg_release_fabric_acl = " + fabric_mod_name + "_release_fabric_acl,\n"
393 buf += " .tpg_get_inst_index = " + fabric_mod_name + "_tpg_get_inst_index,\n"
394 buf += " .release_cmd_to_pool = " + fabric_mod_name + "_release_cmd,\n"
395 buf += " .release_cmd_direct = " + fabric_mod_name + "_release_cmd,\n"
396 buf += " .shutdown_session = " + fabric_mod_name + "_shutdown_session,\n"
397 buf += " .close_session = " + fabric_mod_name + "_close_session,\n"
398 buf += " .stop_session = " + fabric_mod_name + "_stop_session,\n"
399 buf += " .fall_back_to_erl0 = " + fabric_mod_name + "_reset_nexus,\n"
400 buf += " .sess_logged_in = " + fabric_mod_name + "_sess_logged_in,\n"
401 buf += " .sess_get_index = " + fabric_mod_name + "_sess_get_index,\n"
402 buf += " .sess_get_initiator_sid = NULL,\n"
403 buf += " .write_pending = " + fabric_mod_name + "_write_pending,\n"
404 buf += " .write_pending_status = " + fabric_mod_name + "_write_pending_status,\n"
405 buf += " .set_default_node_attributes = " + fabric_mod_name + "_set_default_node_attrs,\n"
406 buf += " .get_task_tag = " + fabric_mod_name + "_get_task_tag,\n"
407 buf += " .get_cmd_state = " + fabric_mod_name + "_get_cmd_state,\n"
408 buf += " .new_cmd_failure = " + fabric_mod_name + "_new_cmd_failure,\n"
409 buf += " .queue_data_in = " + fabric_mod_name + "_queue_data_in,\n"
410 buf += " .queue_status = " + fabric_mod_name + "_queue_status,\n"
411 buf += " .queue_tm_rsp = " + fabric_mod_name + "_queue_tm_rsp,\n"
412 buf += " .get_fabric_sense_len = " + fabric_mod_name + "_get_fabric_sense_len,\n"
413 buf += " .set_fabric_sense_len = " + fabric_mod_name + "_set_fabric_sense_len,\n"
414 buf += " .is_state_remove = " + fabric_mod_name + "_is_state_remove,\n"
415 buf += " .pack_lun = " + fabric_mod_name + "_pack_lun,\n"
416 buf += " /*\n"
417 buf += " * Setup function pointers for generic logic in target_core_fabric_configfs.c\n"
418 buf += " */\n"
419 buf += " .fabric_make_wwn = " + fabric_mod_name + "_make_" + fabric_mod_port + ",\n"
420 buf += " .fabric_drop_wwn = " + fabric_mod_name + "_drop_" + fabric_mod_port + ",\n"
421 buf += " .fabric_make_tpg = " + fabric_mod_name + "_make_tpg,\n"
422 buf += " .fabric_drop_tpg = " + fabric_mod_name + "_drop_tpg,\n"
423 buf += " .fabric_post_link = NULL,\n"
424 buf += " .fabric_pre_unlink = NULL,\n"
425 buf += " .fabric_make_np = NULL,\n"
426 buf += " .fabric_drop_np = NULL,\n"
427 buf += " .fabric_make_nodeacl = " + fabric_mod_name + "_make_nodeacl,\n"
428 buf += " .fabric_drop_nodeacl = " + fabric_mod_name + "_drop_nodeacl,\n"
429 buf += "};\n\n"
430
431 buf += "static int " + fabric_mod_name + "_register_configfs(void)\n"
432 buf += "{\n"
433 buf += " struct target_fabric_configfs *fabric;\n"
434 buf += " int ret;\n\n"
435 buf += " printk(KERN_INFO \"" + fabric_mod_name.upper() + " fabric module %s on %s/%s\"\n"
436 buf += " \" on \"UTS_RELEASE\"\\n\"," + fabric_mod_name.upper() + "_VERSION, utsname()->sysname,\n"
437 buf += " utsname()->machine);\n"
438 buf += " /*\n"
439 buf += " * Register the top level struct config_item_type with TCM core\n"
440 buf += " */\n"
441 buf += " fabric = target_fabric_configfs_init(THIS_MODULE, \"" + fabric_mod_name[4:] + "\");\n"
442 buf += " if (!(fabric)) {\n"
443 buf += " printk(KERN_ERR \"target_fabric_configfs_init() failed\\n\");\n"
444 buf += " return -ENOMEM;\n"
445 buf += " }\n"
446 buf += " /*\n"
447 buf += " * Setup fabric->tf_ops from our local " + fabric_mod_name + "_ops\n"
448 buf += " */\n"
449 buf += " fabric->tf_ops = " + fabric_mod_name + "_ops;\n"
450 buf += " /*\n"
451 buf += " * Setup default attribute lists for various fabric->tf_cit_tmpl\n"
452 buf += " */\n"
453 buf += " TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = " + fabric_mod_name + "_wwn_attrs;\n"
454 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = NULL;\n"
455 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;\n"
456 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;\n"
457 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;\n"
458 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_nacl_base_cit.ct_attrs = NULL;\n"
459 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;\n"
460 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_nacl_auth_cit.ct_attrs = NULL;\n"
461 buf += " TF_CIT_TMPL(fabric)->tfc_tpg_nacl_param_cit.ct_attrs = NULL;\n"
462 buf += " /*\n"
463 buf += " * Register the fabric for use within TCM\n"
464 buf += " */\n"
465 buf += " ret = target_fabric_configfs_register(fabric);\n"
466 buf += " if (ret < 0) {\n"
467 buf += " printk(KERN_ERR \"target_fabric_configfs_register() failed\"\n"
468 buf += " \" for " + fabric_mod_name.upper() + "\\n\");\n"
469 buf += " return ret;\n"
470 buf += " }\n"
471 buf += " /*\n"
472 buf += " * Setup our local pointer to *fabric\n"
473 buf += " */\n"
474 buf += " " + fabric_mod_name + "_fabric_configfs = fabric;\n"
475 buf += " printk(KERN_INFO \"" + fabric_mod_name.upper() + "[0] - Set fabric -> " + fabric_mod_name + "_fabric_configfs\\n\");\n"
476 buf += " return 0;\n"
477 buf += "};\n\n"
478 buf += "static void " + fabric_mod_name + "_deregister_configfs(void)\n"
479 buf += "{\n"
480 buf += " if (!(" + fabric_mod_name + "_fabric_configfs))\n"
481 buf += " return;\n\n"
482 buf += " target_fabric_configfs_deregister(" + fabric_mod_name + "_fabric_configfs);\n"
483 buf += " " + fabric_mod_name + "_fabric_configfs = NULL;\n"
484 buf += " printk(KERN_INFO \"" + fabric_mod_name.upper() + "[0] - Cleared " + fabric_mod_name + "_fabric_configfs\\n\");\n"
485 buf += "};\n\n"
486
487 buf += "static int __init " + fabric_mod_name + "_init(void)\n"
488 buf += "{\n"
489 buf += " int ret;\n\n"
490 buf += " ret = " + fabric_mod_name + "_register_configfs();\n"
491 buf += " if (ret < 0)\n"
492 buf += " return ret;\n\n"
493 buf += " return 0;\n"
494 buf += "};\n\n"
495 buf += "static void " + fabric_mod_name + "_exit(void)\n"
496 buf += "{\n"
497 buf += " " + fabric_mod_name + "_deregister_configfs();\n"
498 buf += "};\n\n"
499
500 buf += "#ifdef MODULE\n"
501 buf += "MODULE_DESCRIPTION(\"" + fabric_mod_name.upper() + " series fabric driver\");\n"
502 buf += "MODULE_LICENSE(\"GPL\");\n"
503 buf += "module_init(" + fabric_mod_name + "_init);\n"
504 buf += "module_exit(" + fabric_mod_name + "_exit);\n"
505 buf += "#endif\n"
506
507 ret = p.write(buf)
508 if ret:
509 tcm_mod_err("Unable to write f: " + f)
510
511 p.close()
512
513 return
514
515def tcm_mod_scan_fabric_ops(tcm_dir):
516
517 fabric_ops_api = tcm_dir + "include/target/target_core_fabric_ops.h"
518
519 print "Using tcm_mod_scan_fabric_ops: " + fabric_ops_api
520 process_fo = 0;
521
522 p = open(fabric_ops_api, 'r')
523
524 line = p.readline()
525 while line:
526 if process_fo == 0 and re.search('struct target_core_fabric_ops {', line):
527 line = p.readline()
528 continue
529
530 if process_fo == 0:
531 process_fo = 1;
532 line = p.readline()
533 # Search for function pointer
534 if not re.search('\(\*', line):
535 continue
536
537 fabric_ops.append(line.rstrip())
538 continue
539
540 line = p.readline()
541 # Search for function pointer
542 if not re.search('\(\*', line):
543 continue
544
545 fabric_ops.append(line.rstrip())
546
547 p.close()
548 return
549
550def tcm_mod_dump_fabric_ops(proto_ident, fabric_mod_dir_var, fabric_mod_name):
551 buf = ""
552 bufi = ""
553
554 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_fabric.c"
555 print "Writing file: " + f
556
557 p = open(f, 'w')
558 if not p:
559 tcm_mod_err("Unable to open file: " + f)
560
561 fi = fabric_mod_dir_var + "/" + fabric_mod_name + "_fabric.h"
562 print "Writing file: " + fi
563
564 pi = open(fi, 'w')
565 if not pi:
566 tcm_mod_err("Unable to open file: " + fi)
567
568 buf = "#include <linux/slab.h>\n"
569 buf += "#include <linux/kthread.h>\n"
570 buf += "#include <linux/types.h>\n"
571 buf += "#include <linux/list.h>\n"
572 buf += "#include <linux/types.h>\n"
573 buf += "#include <linux/string.h>\n"
574 buf += "#include <linux/ctype.h>\n"
575 buf += "#include <asm/unaligned.h>\n"
576 buf += "#include <scsi/scsi.h>\n"
577 buf += "#include <scsi/scsi_host.h>\n"
578 buf += "#include <scsi/scsi_device.h>\n"
579 buf += "#include <scsi/scsi_cmnd.h>\n"
580 buf += "#include <scsi/libfc.h>\n\n"
581 buf += "#include <target/target_core_base.h>\n"
582 buf += "#include <target/target_core_transport.h>\n"
583 buf += "#include <target/target_core_fabric_ops.h>\n"
584 buf += "#include <target/target_core_fabric_lib.h>\n"
585 buf += "#include <target/target_core_device.h>\n"
586 buf += "#include <target/target_core_tpg.h>\n"
587 buf += "#include <target/target_core_configfs.h>\n\n"
588 buf += "#include \"" + fabric_mod_name + "_base.h\"\n"
589 buf += "#include \"" + fabric_mod_name + "_fabric.h\"\n\n"
590
591 buf += "int " + fabric_mod_name + "_check_true(struct se_portal_group *se_tpg)\n"
592 buf += "{\n"
593 buf += " return 1;\n"
594 buf += "}\n\n"
595 bufi += "int " + fabric_mod_name + "_check_true(struct se_portal_group *);\n"
596
597 buf += "int " + fabric_mod_name + "_check_false(struct se_portal_group *se_tpg)\n"
598 buf += "{\n"
599 buf += " return 0;\n"
600 buf += "}\n\n"
601 bufi += "int " + fabric_mod_name + "_check_false(struct se_portal_group *);\n"
602
603 total_fabric_ops = len(fabric_ops)
604 i = 0
605
606 while i < total_fabric_ops:
607 fo = fabric_ops[i]
608 i += 1
609# print "fabric_ops: " + fo
610
611 if re.search('get_fabric_name', fo):
612 buf += "char *" + fabric_mod_name + "_get_fabric_name(void)\n"
613 buf += "{\n"
614 buf += " return \"" + fabric_mod_name[4:] + "\";\n"
615 buf += "}\n\n"
616 bufi += "char *" + fabric_mod_name + "_get_fabric_name(void);\n"
617 continue
618
619 if re.search('get_fabric_proto_ident', fo):
620 buf += "u8 " + fabric_mod_name + "_get_fabric_proto_ident(struct se_portal_group *se_tpg)\n"
621 buf += "{\n"
622 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
623 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
624 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
625 buf += " u8 proto_id;\n\n"
626 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
627 if proto_ident == "FC":
628 buf += " case SCSI_PROTOCOL_FCP:\n"
629 buf += " default:\n"
630 buf += " proto_id = fc_get_fabric_proto_ident(se_tpg);\n"
631 buf += " break;\n"
632 elif proto_ident == "SAS":
633 buf += " case SCSI_PROTOCOL_SAS:\n"
634 buf += " default:\n"
635 buf += " proto_id = sas_get_fabric_proto_ident(se_tpg);\n"
636 buf += " break;\n"
637 elif proto_ident == "iSCSI":
638 buf += " case SCSI_PROTOCOL_ISCSI:\n"
639 buf += " default:\n"
640 buf += " proto_id = iscsi_get_fabric_proto_ident(se_tpg);\n"
641 buf += " break;\n"
642
643 buf += " }\n\n"
644 buf += " return proto_id;\n"
645 buf += "}\n\n"
646 bufi += "u8 " + fabric_mod_name + "_get_fabric_proto_ident(struct se_portal_group *);\n"
647
648 if re.search('get_wwn', fo):
649 buf += "char *" + fabric_mod_name + "_get_fabric_wwn(struct se_portal_group *se_tpg)\n"
650 buf += "{\n"
651 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
652 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
653 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n\n"
654 buf += " return &" + fabric_mod_port + "->" + fabric_mod_port + "_name[0];\n"
655 buf += "}\n\n"
656 bufi += "char *" + fabric_mod_name + "_get_fabric_wwn(struct se_portal_group *);\n"
657
658 if re.search('get_tag', fo):
659 buf += "u16 " + fabric_mod_name + "_get_tag(struct se_portal_group *se_tpg)\n"
660 buf += "{\n"
661 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
662 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
663 buf += " return tpg->" + fabric_mod_port + "_tpgt;\n"
664 buf += "}\n\n"
665 bufi += "u16 " + fabric_mod_name + "_get_tag(struct se_portal_group *);\n"
666
667 if re.search('get_default_depth', fo):
668 buf += "u32 " + fabric_mod_name + "_get_default_depth(struct se_portal_group *se_tpg)\n"
669 buf += "{\n"
670 buf += " return 1;\n"
671 buf += "}\n\n"
672 bufi += "u32 " + fabric_mod_name + "_get_default_depth(struct se_portal_group *);\n"
673
674 if re.search('get_pr_transport_id\)\(', fo):
675 buf += "u32 " + fabric_mod_name + "_get_pr_transport_id(\n"
676 buf += " struct se_portal_group *se_tpg,\n"
677 buf += " struct se_node_acl *se_nacl,\n"
678 buf += " struct t10_pr_registration *pr_reg,\n"
679 buf += " int *format_code,\n"
680 buf += " unsigned char *buf)\n"
681 buf += "{\n"
682 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
683 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
684 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
685 buf += " int ret = 0;\n\n"
686 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
687 if proto_ident == "FC":
688 buf += " case SCSI_PROTOCOL_FCP:\n"
689 buf += " default:\n"
690 buf += " ret = fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,\n"
691 buf += " format_code, buf);\n"
692 buf += " break;\n"
693 elif proto_ident == "SAS":
694 buf += " case SCSI_PROTOCOL_SAS:\n"
695 buf += " default:\n"
696 buf += " ret = sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,\n"
697 buf += " format_code, buf);\n"
698 buf += " break;\n"
699 elif proto_ident == "iSCSI":
700 buf += " case SCSI_PROTOCOL_ISCSI:\n"
701 buf += " default:\n"
702 buf += " ret = iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,\n"
703 buf += " format_code, buf);\n"
704 buf += " break;\n"
705
706 buf += " }\n\n"
707 buf += " return ret;\n"
708 buf += "}\n\n"
709 bufi += "u32 " + fabric_mod_name + "_get_pr_transport_id(struct se_portal_group *,\n"
710 bufi += " struct se_node_acl *, struct t10_pr_registration *,\n"
711 bufi += " int *, unsigned char *);\n"
712
713 if re.search('get_pr_transport_id_len\)\(', fo):
714 buf += "u32 " + fabric_mod_name + "_get_pr_transport_id_len(\n"
715 buf += " struct se_portal_group *se_tpg,\n"
716 buf += " struct se_node_acl *se_nacl,\n"
717 buf += " struct t10_pr_registration *pr_reg,\n"
718 buf += " int *format_code)\n"
719 buf += "{\n"
720 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
721 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
722 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
723 buf += " int ret = 0;\n\n"
724 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
725 if proto_ident == "FC":
726 buf += " case SCSI_PROTOCOL_FCP:\n"
727 buf += " default:\n"
728 buf += " ret = fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,\n"
729 buf += " format_code);\n"
730 buf += " break;\n"
731 elif proto_ident == "SAS":
732 buf += " case SCSI_PROTOCOL_SAS:\n"
733 buf += " default:\n"
734 buf += " ret = sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,\n"
735 buf += " format_code);\n"
736 buf += " break;\n"
737 elif proto_ident == "iSCSI":
738 buf += " case SCSI_PROTOCOL_ISCSI:\n"
739 buf += " default:\n"
740 buf += " ret = iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,\n"
741 buf += " format_code);\n"
742 buf += " break;\n"
743
744
745 buf += " }\n\n"
746 buf += " return ret;\n"
747 buf += "}\n\n"
748 bufi += "u32 " + fabric_mod_name + "_get_pr_transport_id_len(struct se_portal_group *,\n"
749 bufi += " struct se_node_acl *, struct t10_pr_registration *,\n"
750 bufi += " int *);\n"
751
752 if re.search('parse_pr_out_transport_id\)\(', fo):
753 buf += "char *" + fabric_mod_name + "_parse_pr_out_transport_id(\n"
754 buf += " struct se_portal_group *se_tpg,\n"
755 buf += " const char *buf,\n"
756 buf += " u32 *out_tid_len,\n"
757 buf += " char **port_nexus_ptr)\n"
758 buf += "{\n"
759 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
760 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
761 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n"
762 buf += " char *tid = NULL;\n\n"
763 buf += " switch (" + fabric_mod_port + "->" + fabric_mod_port + "_proto_id) {\n"
764 if proto_ident == "FC":
765 buf += " case SCSI_PROTOCOL_FCP:\n"
766 buf += " default:\n"
767 buf += " tid = fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,\n"
768 buf += " port_nexus_ptr);\n"
769 elif proto_ident == "SAS":
770 buf += " case SCSI_PROTOCOL_SAS:\n"
771 buf += " default:\n"
772 buf += " tid = sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,\n"
773 buf += " port_nexus_ptr);\n"
774 elif proto_ident == "iSCSI":
775 buf += " case SCSI_PROTOCOL_ISCSI:\n"
776 buf += " default:\n"
777 buf += " tid = iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,\n"
778 buf += " port_nexus_ptr);\n"
779
780 buf += " }\n\n"
781 buf += " return tid;\n"
782 buf += "}\n\n"
783 bufi += "char *" + fabric_mod_name + "_parse_pr_out_transport_id(struct se_portal_group *,\n"
784 bufi += " const char *, u32 *, char **);\n"
785
786 if re.search('alloc_fabric_acl\)\(', fo):
787 buf += "struct se_node_acl *" + fabric_mod_name + "_alloc_fabric_acl(struct se_portal_group *se_tpg)\n"
788 buf += "{\n"
789 buf += " struct " + fabric_mod_name + "_nacl *nacl;\n\n"
790 buf += " nacl = kzalloc(sizeof(struct " + fabric_mod_name + "_nacl), GFP_KERNEL);\n"
791 buf += " if (!(nacl)) {\n"
792 buf += " printk(KERN_ERR \"Unable to alocate struct " + fabric_mod_name + "_nacl\\n\");\n"
793 buf += " return NULL;\n"
794 buf += " }\n\n"
795 buf += " return &nacl->se_node_acl;\n"
796 buf += "}\n\n"
797 bufi += "struct se_node_acl *" + fabric_mod_name + "_alloc_fabric_acl(struct se_portal_group *);\n"
798
799 if re.search('release_fabric_acl\)\(', fo):
800 buf += "void " + fabric_mod_name + "_release_fabric_acl(\n"
801 buf += " struct se_portal_group *se_tpg,\n"
802 buf += " struct se_node_acl *se_nacl)\n"
803 buf += "{\n"
804 buf += " struct " + fabric_mod_name + "_nacl *nacl = container_of(se_nacl,\n"
805 buf += " struct " + fabric_mod_name + "_nacl, se_node_acl);\n"
806 buf += " kfree(nacl);\n"
807 buf += "}\n\n"
808 bufi += "void " + fabric_mod_name + "_release_fabric_acl(struct se_portal_group *,\n"
809 bufi += " struct se_node_acl *);\n"
810
811 if re.search('tpg_get_inst_index\)\(', fo):
812 buf += "u32 " + fabric_mod_name + "_tpg_get_inst_index(struct se_portal_group *se_tpg)\n"
813 buf += "{\n"
814 buf += " return 1;\n"
815 buf += "}\n\n"
816 bufi += "u32 " + fabric_mod_name + "_tpg_get_inst_index(struct se_portal_group *);\n"
817
818 if re.search('release_cmd_to_pool', fo):
819 buf += "void " + fabric_mod_name + "_release_cmd(struct se_cmd *se_cmd)\n"
820 buf += "{\n"
821 buf += " return;\n"
822 buf += "}\n\n"
823 bufi += "void " + fabric_mod_name + "_release_cmd(struct se_cmd *);\n"
824
825 if re.search('shutdown_session\)\(', fo):
826 buf += "int " + fabric_mod_name + "_shutdown_session(struct se_session *se_sess)\n"
827 buf += "{\n"
828 buf += " return 0;\n"
829 buf += "}\n\n"
830 bufi += "int " + fabric_mod_name + "_shutdown_session(struct se_session *);\n"
831
832 if re.search('close_session\)\(', fo):
833 buf += "void " + fabric_mod_name + "_close_session(struct se_session *se_sess)\n"
834 buf += "{\n"
835 buf += " return;\n"
836 buf += "}\n\n"
837 bufi += "void " + fabric_mod_name + "_close_session(struct se_session *);\n"
838
839 if re.search('stop_session\)\(', fo):
840 buf += "void " + fabric_mod_name + "_stop_session(struct se_session *se_sess, int sess_sleep , int conn_sleep)\n"
841 buf += "{\n"
842 buf += " return;\n"
843 buf += "}\n\n"
844 bufi += "void " + fabric_mod_name + "_stop_session(struct se_session *, int, int);\n"
845
846 if re.search('fall_back_to_erl0\)\(', fo):
847 buf += "void " + fabric_mod_name + "_reset_nexus(struct se_session *se_sess)\n"
848 buf += "{\n"
849 buf += " return;\n"
850 buf += "}\n\n"
851 bufi += "void " + fabric_mod_name + "_reset_nexus(struct se_session *);\n"
852
853 if re.search('sess_logged_in\)\(', fo):
854 buf += "int " + fabric_mod_name + "_sess_logged_in(struct se_session *se_sess)\n"
855 buf += "{\n"
856 buf += " return 0;\n"
857 buf += "}\n\n"
858 bufi += "int " + fabric_mod_name + "_sess_logged_in(struct se_session *);\n"
859
860 if re.search('sess_get_index\)\(', fo):
861 buf += "u32 " + fabric_mod_name + "_sess_get_index(struct se_session *se_sess)\n"
862 buf += "{\n"
863 buf += " return 0;\n"
864 buf += "}\n\n"
865 bufi += "u32 " + fabric_mod_name + "_sess_get_index(struct se_session *);\n"
866
867 if re.search('write_pending\)\(', fo):
868 buf += "int " + fabric_mod_name + "_write_pending(struct se_cmd *se_cmd)\n"
869 buf += "{\n"
870 buf += " return 0;\n"
871 buf += "}\n\n"
872 bufi += "int " + fabric_mod_name + "_write_pending(struct se_cmd *);\n"
873
874 if re.search('write_pending_status\)\(', fo):
875 buf += "int " + fabric_mod_name + "_write_pending_status(struct se_cmd *se_cmd)\n"
876 buf += "{\n"
877 buf += " return 0;\n"
878 buf += "}\n\n"
879 bufi += "int " + fabric_mod_name + "_write_pending_status(struct se_cmd *);\n"
880
881 if re.search('set_default_node_attributes\)\(', fo):
882 buf += "void " + fabric_mod_name + "_set_default_node_attrs(struct se_node_acl *nacl)\n"
883 buf += "{\n"
884 buf += " return;\n"
885 buf += "}\n\n"
886 bufi += "void " + fabric_mod_name + "_set_default_node_attrs(struct se_node_acl *);\n"
887
888 if re.search('get_task_tag\)\(', fo):
889 buf += "u32 " + fabric_mod_name + "_get_task_tag(struct se_cmd *se_cmd)\n"
890 buf += "{\n"
891 buf += " return 0;\n"
892 buf += "}\n\n"
893 bufi += "u32 " + fabric_mod_name + "_get_task_tag(struct se_cmd *);\n"
894
895 if re.search('get_cmd_state\)\(', fo):
896 buf += "int " + fabric_mod_name + "_get_cmd_state(struct se_cmd *se_cmd)\n"
897 buf += "{\n"
898 buf += " return 0;\n"
899 buf += "}\n\n"
900 bufi += "int " + fabric_mod_name + "_get_cmd_state(struct se_cmd *);\n"
901
902 if re.search('new_cmd_failure\)\(', fo):
903 buf += "void " + fabric_mod_name + "_new_cmd_failure(struct se_cmd *se_cmd)\n"
904 buf += "{\n"
905 buf += " return;\n"
906 buf += "}\n\n"
907 bufi += "void " + fabric_mod_name + "_new_cmd_failure(struct se_cmd *);\n"
908
909 if re.search('queue_data_in\)\(', fo):
910 buf += "int " + fabric_mod_name + "_queue_data_in(struct se_cmd *se_cmd)\n"
911 buf += "{\n"
912 buf += " return 0;\n"
913 buf += "}\n\n"
914 bufi += "int " + fabric_mod_name + "_queue_data_in(struct se_cmd *);\n"
915
916 if re.search('queue_status\)\(', fo):
917 buf += "int " + fabric_mod_name + "_queue_status(struct se_cmd *se_cmd)\n"
918 buf += "{\n"
919 buf += " return 0;\n"
920 buf += "}\n\n"
921 bufi += "int " + fabric_mod_name + "_queue_status(struct se_cmd *);\n"
922
923 if re.search('queue_tm_rsp\)\(', fo):
924 buf += "int " + fabric_mod_name + "_queue_tm_rsp(struct se_cmd *se_cmd)\n"
925 buf += "{\n"
926 buf += " return 0;\n"
927 buf += "}\n\n"
928 bufi += "int " + fabric_mod_name + "_queue_tm_rsp(struct se_cmd *);\n"
929
930 if re.search('get_fabric_sense_len\)\(', fo):
931 buf += "u16 " + fabric_mod_name + "_get_fabric_sense_len(void)\n"
932 buf += "{\n"
933 buf += " return 0;\n"
934 buf += "}\n\n"
935 bufi += "u16 " + fabric_mod_name + "_get_fabric_sense_len(void);\n"
936
937 if re.search('set_fabric_sense_len\)\(', fo):
938 buf += "u16 " + fabric_mod_name + "_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_length)\n"
939 buf += "{\n"
940 buf += " return 0;\n"
941 buf += "}\n\n"
942 bufi += "u16 " + fabric_mod_name + "_set_fabric_sense_len(struct se_cmd *, u32);\n"
943
944 if re.search('is_state_remove\)\(', fo):
945 buf += "int " + fabric_mod_name + "_is_state_remove(struct se_cmd *se_cmd)\n"
946 buf += "{\n"
947 buf += " return 0;\n"
948 buf += "}\n\n"
949 bufi += "int " + fabric_mod_name + "_is_state_remove(struct se_cmd *);\n"
950
951 if re.search('pack_lun\)\(', fo):
952 buf += "u64 " + fabric_mod_name + "_pack_lun(unsigned int lun)\n"
953 buf += "{\n"
954 buf += " WARN_ON(lun >= 256);\n"
955 buf += " /* Caller wants this byte-swapped */\n"
956 buf += " return cpu_to_le64((lun & 0xff) << 8);\n"
957 buf += "}\n\n"
958 bufi += "u64 " + fabric_mod_name + "_pack_lun(unsigned int);\n"
959
960
961 ret = p.write(buf)
962 if ret:
963 tcm_mod_err("Unable to write f: " + f)
964
965 p.close()
966
967 ret = pi.write(bufi)
968 if ret:
969 tcm_mod_err("Unable to write fi: " + fi)
970
971 pi.close()
972 return
973
974def tcm_mod_build_kbuild(fabric_mod_dir_var, fabric_mod_name):
975
976 buf = ""
977 f = fabric_mod_dir_var + "/Makefile"
978 print "Writing file: " + f
979
980 p = open(f, 'w')
981 if not p:
982 tcm_mod_err("Unable to open file: " + f)
983
984 buf += fabric_mod_name + "-objs := " + fabric_mod_name + "_fabric.o \\\n"
985 buf += " " + fabric_mod_name + "_configfs.o\n"
986 buf += "obj-$(CONFIG_" + fabric_mod_name.upper() + ") += " + fabric_mod_name + ".o\n"
987
988 ret = p.write(buf)
989 if ret:
990 tcm_mod_err("Unable to write f: " + f)
991
992 p.close()
993 return
994
995def tcm_mod_build_kconfig(fabric_mod_dir_var, fabric_mod_name):
996
997 buf = ""
998 f = fabric_mod_dir_var + "/Kconfig"
999 print "Writing file: " + f
1000
1001 p = open(f, 'w')
1002 if not p:
1003 tcm_mod_err("Unable to open file: " + f)
1004
1005 buf = "config " + fabric_mod_name.upper() + "\n"
1006 buf += " tristate \"" + fabric_mod_name.upper() + " fabric module\"\n"
1007 buf += " depends on TARGET_CORE && CONFIGFS_FS\n"
1008 buf += " default n\n"
1009 buf += " ---help---\n"
1010 buf += " Say Y here to enable the " + fabric_mod_name.upper() + " fabric module\n"
1011
1012 ret = p.write(buf)
1013 if ret:
1014 tcm_mod_err("Unable to write f: " + f)
1015
1016 p.close()
1017 return
1018
1019def tcm_mod_add_kbuild(tcm_dir, fabric_mod_name):
1020 buf = "obj-$(CONFIG_" + fabric_mod_name.upper() + ") += " + fabric_mod_name.lower() + "/\n"
1021 kbuild = tcm_dir + "/drivers/target/Makefile"
1022
1023 f = open(kbuild, 'a')
1024 f.write(buf)
1025 f.close()
1026 return
1027
1028def tcm_mod_add_kconfig(tcm_dir, fabric_mod_name):
1029 buf = "source \"drivers/target/" + fabric_mod_name.lower() + "/Kconfig\"\n"
1030 kconfig = tcm_dir + "/drivers/target/Kconfig"
1031
1032 f = open(kconfig, 'a')
1033 f.write(buf)
1034 f.close()
1035 return
1036
1037def main(modname, proto_ident):
1038# proto_ident = "FC"
1039# proto_ident = "SAS"
1040# proto_ident = "iSCSI"
1041
1042 tcm_dir = os.getcwd();
1043 tcm_dir += "/../../"
1044 print "tcm_dir: " + tcm_dir
1045 fabric_mod_name = modname
1046 fabric_mod_dir = tcm_dir + "drivers/target/" + fabric_mod_name
1047 print "Set fabric_mod_name: " + fabric_mod_name
1048 print "Set fabric_mod_dir: " + fabric_mod_dir
1049 print "Using proto_ident: " + proto_ident
1050
1051 if proto_ident != "FC" and proto_ident != "SAS" and proto_ident != "iSCSI":
1052 print "Unsupported proto_ident: " + proto_ident
1053 sys.exit(1)
1054
1055 ret = tcm_mod_create_module_subdir(fabric_mod_dir)
1056 if ret:
1057 print "tcm_mod_create_module_subdir() failed because module already exists!"
1058 sys.exit(1)
1059
1060 tcm_mod_build_base_includes(proto_ident, fabric_mod_dir, fabric_mod_name)
1061 tcm_mod_scan_fabric_ops(tcm_dir)
1062 tcm_mod_dump_fabric_ops(proto_ident, fabric_mod_dir, fabric_mod_name)
1063 tcm_mod_build_configfs(proto_ident, fabric_mod_dir, fabric_mod_name)
1064 tcm_mod_build_kbuild(fabric_mod_dir, fabric_mod_name)
1065 tcm_mod_build_kconfig(fabric_mod_dir, fabric_mod_name)
1066
1067 input = raw_input("Would you like to add " + fabric_mod_name + "to drivers/target/Makefile..? [yes,no]: ")
1068 if input == "yes" or input == "y":
1069 tcm_mod_add_kbuild(tcm_dir, fabric_mod_name)
1070
1071 input = raw_input("Would you like to add " + fabric_mod_name + "to drivers/target/Kconfig..? [yes,no]: ")
1072 if input == "yes" or input == "y":
1073 tcm_mod_add_kconfig(tcm_dir, fabric_mod_name)
1074
1075 return
1076
1077parser = optparse.OptionParser()
1078parser.add_option('-m', '--modulename', help='Module name', dest='modname',
1079 action='store', nargs=1, type='string')
1080parser.add_option('-p', '--protoident', help='Protocol Ident', dest='protoident',
1081 action='store', nargs=1, type='string')
1082
1083(opts, args) = parser.parse_args()
1084
1085mandatories = ['modname', 'protoident']
1086for m in mandatories:
1087 if not opts.__dict__[m]:
1088 print "mandatory option is missing\n"
1089 parser.print_help()
1090 exit(-1)
1091
1092if __name__ == "__main__":
1093
1094 main(str(opts.modname), opts.protoident)
1#!/usr/bin/python
2# The TCM v4 multi-protocol fabric module generation script for drivers/target/$NEW_MOD
3#
4# Copyright (c) 2010 Rising Tide Systems
5# Copyright (c) 2010 Linux-iSCSI.org
6#
7# Author: nab@kernel.org
8#
9import os, sys
10import subprocess as sub
11import string
12import re
13import optparse
14
15tcm_dir = ""
16
17fabric_ops = []
18fabric_mod_dir = ""
19fabric_mod_port = ""
20fabric_mod_init_port = ""
21
22def tcm_mod_err(msg):
23 print msg
24 sys.exit(1)
25
26def tcm_mod_create_module_subdir(fabric_mod_dir_var):
27
28 if os.path.isdir(fabric_mod_dir_var) == True:
29 return 1
30
31 print "Creating fabric_mod_dir: " + fabric_mod_dir_var
32 ret = os.mkdir(fabric_mod_dir_var)
33 if ret:
34 tcm_mod_err("Unable to mkdir " + fabric_mod_dir_var)
35
36 return
37
38def tcm_mod_build_FC_include(fabric_mod_dir_var, fabric_mod_name):
39 global fabric_mod_port
40 global fabric_mod_init_port
41 buf = ""
42
43 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
44 print "Writing file: " + f
45
46 p = open(f, 'w');
47 if not p:
48 tcm_mod_err("Unable to open file: " + f)
49
50 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
51 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
52 buf += "\n"
53 buf += "struct " + fabric_mod_name + "_tpg {\n"
54 buf += " /* FC lport target portal group tag for TCM */\n"
55 buf += " u16 lport_tpgt;\n"
56 buf += " /* Pointer back to " + fabric_mod_name + "_lport */\n"
57 buf += " struct " + fabric_mod_name + "_lport *lport;\n"
58 buf += " /* Returned by " + fabric_mod_name + "_make_tpg() */\n"
59 buf += " struct se_portal_group se_tpg;\n"
60 buf += "};\n"
61 buf += "\n"
62 buf += "struct " + fabric_mod_name + "_lport {\n"
63 buf += " /* Binary World Wide unique Port Name for FC Target Lport */\n"
64 buf += " u64 lport_wwpn;\n"
65 buf += " /* ASCII formatted WWPN for FC Target Lport */\n"
66 buf += " char lport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
67 buf += " /* Returned by " + fabric_mod_name + "_make_lport() */\n"
68 buf += " struct se_wwn lport_wwn;\n"
69 buf += "};\n"
70
71 ret = p.write(buf)
72 if ret:
73 tcm_mod_err("Unable to write f: " + f)
74
75 p.close()
76
77 fabric_mod_port = "lport"
78 fabric_mod_init_port = "nport"
79
80 return
81
82def tcm_mod_build_SAS_include(fabric_mod_dir_var, fabric_mod_name):
83 global fabric_mod_port
84 global fabric_mod_init_port
85 buf = ""
86
87 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
88 print "Writing file: " + f
89
90 p = open(f, 'w');
91 if not p:
92 tcm_mod_err("Unable to open file: " + f)
93
94 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
95 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
96 buf += "\n"
97 buf += "struct " + fabric_mod_name + "_tpg {\n"
98 buf += " /* SAS port target portal group tag for TCM */\n"
99 buf += " u16 tport_tpgt;\n"
100 buf += " /* Pointer back to " + fabric_mod_name + "_tport */\n"
101 buf += " struct " + fabric_mod_name + "_tport *tport;\n"
102 buf += " /* Returned by " + fabric_mod_name + "_make_tpg() */\n"
103 buf += " struct se_portal_group se_tpg;\n"
104 buf += "};\n\n"
105 buf += "struct " + fabric_mod_name + "_tport {\n"
106 buf += " /* Binary World Wide unique Port Name for SAS Target port */\n"
107 buf += " u64 tport_wwpn;\n"
108 buf += " /* ASCII formatted WWPN for SAS Target port */\n"
109 buf += " char tport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
110 buf += " /* Returned by " + fabric_mod_name + "_make_tport() */\n"
111 buf += " struct se_wwn tport_wwn;\n"
112 buf += "};\n"
113
114 ret = p.write(buf)
115 if ret:
116 tcm_mod_err("Unable to write f: " + f)
117
118 p.close()
119
120 fabric_mod_port = "tport"
121 fabric_mod_init_port = "iport"
122
123 return
124
125def tcm_mod_build_iSCSI_include(fabric_mod_dir_var, fabric_mod_name):
126 global fabric_mod_port
127 global fabric_mod_init_port
128 buf = ""
129
130 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_base.h"
131 print "Writing file: " + f
132
133 p = open(f, 'w');
134 if not p:
135 tcm_mod_err("Unable to open file: " + f)
136
137 buf = "#define " + fabric_mod_name.upper() + "_VERSION \"v0.1\"\n"
138 buf += "#define " + fabric_mod_name.upper() + "_NAMELEN 32\n"
139 buf += "\n"
140 buf += "struct " + fabric_mod_name + "_tpg {\n"
141 buf += " /* iSCSI target portal group tag for TCM */\n"
142 buf += " u16 tport_tpgt;\n"
143 buf += " /* Pointer back to " + fabric_mod_name + "_tport */\n"
144 buf += " struct " + fabric_mod_name + "_tport *tport;\n"
145 buf += " /* Returned by " + fabric_mod_name + "_make_tpg() */\n"
146 buf += " struct se_portal_group se_tpg;\n"
147 buf += "};\n\n"
148 buf += "struct " + fabric_mod_name + "_tport {\n"
149 buf += " /* ASCII formatted TargetName for IQN */\n"
150 buf += " char tport_name[" + fabric_mod_name.upper() + "_NAMELEN];\n"
151 buf += " /* Returned by " + fabric_mod_name + "_make_tport() */\n"
152 buf += " struct se_wwn tport_wwn;\n"
153 buf += "};\n"
154
155 ret = p.write(buf)
156 if ret:
157 tcm_mod_err("Unable to write f: " + f)
158
159 p.close()
160
161 fabric_mod_port = "tport"
162 fabric_mod_init_port = "iport"
163
164 return
165
166def tcm_mod_build_base_includes(proto_ident, fabric_mod_dir_val, fabric_mod_name):
167
168 if proto_ident == "FC":
169 tcm_mod_build_FC_include(fabric_mod_dir_val, fabric_mod_name)
170 elif proto_ident == "SAS":
171 tcm_mod_build_SAS_include(fabric_mod_dir_val, fabric_mod_name)
172 elif proto_ident == "iSCSI":
173 tcm_mod_build_iSCSI_include(fabric_mod_dir_val, fabric_mod_name)
174 else:
175 print "Unsupported proto_ident: " + proto_ident
176 sys.exit(1)
177
178 return
179
180def tcm_mod_build_configfs(proto_ident, fabric_mod_dir_var, fabric_mod_name):
181 buf = ""
182
183 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_configfs.c"
184 print "Writing file: " + f
185
186 p = open(f, 'w');
187 if not p:
188 tcm_mod_err("Unable to open file: " + f)
189
190 buf = "#include <linux/module.h>\n"
191 buf += "#include <linux/moduleparam.h>\n"
192 buf += "#include <linux/version.h>\n"
193 buf += "#include <generated/utsrelease.h>\n"
194 buf += "#include <linux/utsname.h>\n"
195 buf += "#include <linux/init.h>\n"
196 buf += "#include <linux/slab.h>\n"
197 buf += "#include <linux/kthread.h>\n"
198 buf += "#include <linux/types.h>\n"
199 buf += "#include <linux/string.h>\n"
200 buf += "#include <linux/configfs.h>\n"
201 buf += "#include <linux/ctype.h>\n"
202 buf += "#include <asm/unaligned.h>\n"
203 buf += "#include <scsi/scsi_proto.h>\n\n"
204 buf += "#include <target/target_core_base.h>\n"
205 buf += "#include <target/target_core_fabric.h>\n"
206 buf += "#include \"" + fabric_mod_name + "_base.h\"\n"
207 buf += "#include \"" + fabric_mod_name + "_fabric.h\"\n\n"
208
209 buf += "static const struct target_core_fabric_ops " + fabric_mod_name + "_ops;\n\n"
210
211 buf += "static struct se_portal_group *" + fabric_mod_name + "_make_tpg(\n"
212 buf += " struct se_wwn *wwn,\n"
213 buf += " struct config_group *group,\n"
214 buf += " const char *name)\n"
215 buf += "{\n"
216 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + "*" + fabric_mod_port + " = container_of(wwn,\n"
217 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + ", " + fabric_mod_port + "_wwn);\n\n"
218 buf += " struct " + fabric_mod_name + "_tpg *tpg;\n"
219 buf += " unsigned long tpgt;\n"
220 buf += " int ret;\n\n"
221 buf += " if (strstr(name, \"tpgt_\") != name)\n"
222 buf += " return ERR_PTR(-EINVAL);\n"
223 buf += " if (kstrtoul(name + 5, 10, &tpgt) || tpgt > UINT_MAX)\n"
224 buf += " return ERR_PTR(-EINVAL);\n\n"
225 buf += " tpg = kzalloc(sizeof(struct " + fabric_mod_name + "_tpg), GFP_KERNEL);\n"
226 buf += " if (!tpg) {\n"
227 buf += " printk(KERN_ERR \"Unable to allocate struct " + fabric_mod_name + "_tpg\");\n"
228 buf += " return ERR_PTR(-ENOMEM);\n"
229 buf += " }\n"
230 buf += " tpg->" + fabric_mod_port + " = " + fabric_mod_port + ";\n"
231 buf += " tpg->" + fabric_mod_port + "_tpgt = tpgt;\n\n"
232
233 if proto_ident == "FC":
234 buf += " ret = core_tpg_register(wwn, &tpg->se_tpg, SCSI_PROTOCOL_FCP);\n"
235 elif proto_ident == "SAS":
236 buf += " ret = core_tpg_register(wwn, &tpg->se_tpg, SCSI_PROTOCOL_SAS);\n"
237 elif proto_ident == "iSCSI":
238 buf += " ret = core_tpg_register(wwn, &tpg->se_tpg, SCSI_PROTOCOL_ISCSI);\n"
239
240 buf += " if (ret < 0) {\n"
241 buf += " kfree(tpg);\n"
242 buf += " return NULL;\n"
243 buf += " }\n"
244 buf += " return &tpg->se_tpg;\n"
245 buf += "}\n\n"
246 buf += "static void " + fabric_mod_name + "_drop_tpg(struct se_portal_group *se_tpg)\n"
247 buf += "{\n"
248 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
249 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n\n"
250 buf += " core_tpg_deregister(se_tpg);\n"
251 buf += " kfree(tpg);\n"
252 buf += "}\n\n"
253
254 buf += "static struct se_wwn *" + fabric_mod_name + "_make_" + fabric_mod_port + "(\n"
255 buf += " struct target_fabric_configfs *tf,\n"
256 buf += " struct config_group *group,\n"
257 buf += " const char *name)\n"
258 buf += "{\n"
259 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + ";\n"
260
261 if proto_ident == "FC" or proto_ident == "SAS":
262 buf += " u64 wwpn = 0;\n\n"
263
264 buf += " /* if (" + fabric_mod_name + "_parse_wwn(name, &wwpn, 1) < 0)\n"
265 buf += " return ERR_PTR(-EINVAL); */\n\n"
266 buf += " " + fabric_mod_port + " = kzalloc(sizeof(struct " + fabric_mod_name + "_" + fabric_mod_port + "), GFP_KERNEL);\n"
267 buf += " if (!" + fabric_mod_port + ") {\n"
268 buf += " printk(KERN_ERR \"Unable to allocate struct " + fabric_mod_name + "_" + fabric_mod_port + "\");\n"
269 buf += " return ERR_PTR(-ENOMEM);\n"
270 buf += " }\n"
271
272 if proto_ident == "FC" or proto_ident == "SAS":
273 buf += " " + fabric_mod_port + "->" + fabric_mod_port + "_wwpn = wwpn;\n"
274
275 buf += " /* " + fabric_mod_name + "_format_wwn(&" + fabric_mod_port + "->" + fabric_mod_port + "_name[0], " + fabric_mod_name.upper() + "_NAMELEN, wwpn); */\n\n"
276 buf += " return &" + fabric_mod_port + "->" + fabric_mod_port + "_wwn;\n"
277 buf += "}\n\n"
278 buf += "static void " + fabric_mod_name + "_drop_" + fabric_mod_port + "(struct se_wwn *wwn)\n"
279 buf += "{\n"
280 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = container_of(wwn,\n"
281 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + ", " + fabric_mod_port + "_wwn);\n"
282 buf += " kfree(" + fabric_mod_port + ");\n"
283 buf += "}\n\n"
284
285 buf += "static const struct target_core_fabric_ops " + fabric_mod_name + "_ops = {\n"
286 buf += " .module = THIS_MODULE,\n"
287 buf += " .name = \"" + fabric_mod_name + "\",\n"
288 buf += " .get_fabric_name = " + fabric_mod_name + "_get_fabric_name,\n"
289 buf += " .tpg_get_wwn = " + fabric_mod_name + "_get_fabric_wwn,\n"
290 buf += " .tpg_get_tag = " + fabric_mod_name + "_get_tag,\n"
291 buf += " .tpg_check_demo_mode = " + fabric_mod_name + "_check_false,\n"
292 buf += " .tpg_check_demo_mode_cache = " + fabric_mod_name + "_check_true,\n"
293 buf += " .tpg_check_demo_mode_write_protect = " + fabric_mod_name + "_check_true,\n"
294 buf += " .tpg_check_prod_mode_write_protect = " + fabric_mod_name + "_check_false,\n"
295 buf += " .tpg_get_inst_index = " + fabric_mod_name + "_tpg_get_inst_index,\n"
296 buf += " .release_cmd = " + fabric_mod_name + "_release_cmd,\n"
297 buf += " .sess_get_index = " + fabric_mod_name + "_sess_get_index,\n"
298 buf += " .sess_get_initiator_sid = NULL,\n"
299 buf += " .write_pending = " + fabric_mod_name + "_write_pending,\n"
300 buf += " .set_default_node_attributes = " + fabric_mod_name + "_set_default_node_attrs,\n"
301 buf += " .get_cmd_state = " + fabric_mod_name + "_get_cmd_state,\n"
302 buf += " .queue_data_in = " + fabric_mod_name + "_queue_data_in,\n"
303 buf += " .queue_status = " + fabric_mod_name + "_queue_status,\n"
304 buf += " .queue_tm_rsp = " + fabric_mod_name + "_queue_tm_rsp,\n"
305 buf += " .aborted_task = " + fabric_mod_name + "_aborted_task,\n"
306 buf += " /*\n"
307 buf += " * Setup function pointers for generic logic in target_core_fabric_configfs.c\n"
308 buf += " */\n"
309 buf += " .fabric_make_wwn = " + fabric_mod_name + "_make_" + fabric_mod_port + ",\n"
310 buf += " .fabric_drop_wwn = " + fabric_mod_name + "_drop_" + fabric_mod_port + ",\n"
311 buf += " .fabric_make_tpg = " + fabric_mod_name + "_make_tpg,\n"
312 buf += " .fabric_drop_tpg = " + fabric_mod_name + "_drop_tpg,\n"
313 buf += "};\n\n"
314
315 buf += "static int __init " + fabric_mod_name + "_init(void)\n"
316 buf += "{\n"
317 buf += " return target_register_template(&" + fabric_mod_name + "_ops);\n"
318 buf += "};\n\n"
319
320 buf += "static void __exit " + fabric_mod_name + "_exit(void)\n"
321 buf += "{\n"
322 buf += " target_unregister_template(&" + fabric_mod_name + "_ops);\n"
323 buf += "};\n\n"
324
325 buf += "MODULE_DESCRIPTION(\"" + fabric_mod_name.upper() + " series fabric driver\");\n"
326 buf += "MODULE_LICENSE(\"GPL\");\n"
327 buf += "module_init(" + fabric_mod_name + "_init);\n"
328 buf += "module_exit(" + fabric_mod_name + "_exit);\n"
329
330 ret = p.write(buf)
331 if ret:
332 tcm_mod_err("Unable to write f: " + f)
333
334 p.close()
335
336 return
337
338def tcm_mod_scan_fabric_ops(tcm_dir):
339
340 fabric_ops_api = tcm_dir + "include/target/target_core_fabric.h"
341
342 print "Using tcm_mod_scan_fabric_ops: " + fabric_ops_api
343 process_fo = 0;
344
345 p = open(fabric_ops_api, 'r')
346
347 line = p.readline()
348 while line:
349 if process_fo == 0 and re.search('struct target_core_fabric_ops {', line):
350 line = p.readline()
351 continue
352
353 if process_fo == 0:
354 process_fo = 1;
355 line = p.readline()
356 # Search for function pointer
357 if not re.search('\(\*', line):
358 continue
359
360 fabric_ops.append(line.rstrip())
361 continue
362
363 line = p.readline()
364 # Search for function pointer
365 if not re.search('\(\*', line):
366 continue
367
368 fabric_ops.append(line.rstrip())
369
370 p.close()
371 return
372
373def tcm_mod_dump_fabric_ops(proto_ident, fabric_mod_dir_var, fabric_mod_name):
374 buf = ""
375 bufi = ""
376
377 f = fabric_mod_dir_var + "/" + fabric_mod_name + "_fabric.c"
378 print "Writing file: " + f
379
380 p = open(f, 'w')
381 if not p:
382 tcm_mod_err("Unable to open file: " + f)
383
384 fi = fabric_mod_dir_var + "/" + fabric_mod_name + "_fabric.h"
385 print "Writing file: " + fi
386
387 pi = open(fi, 'w')
388 if not pi:
389 tcm_mod_err("Unable to open file: " + fi)
390
391 buf = "#include <linux/slab.h>\n"
392 buf += "#include <linux/kthread.h>\n"
393 buf += "#include <linux/types.h>\n"
394 buf += "#include <linux/list.h>\n"
395 buf += "#include <linux/types.h>\n"
396 buf += "#include <linux/string.h>\n"
397 buf += "#include <linux/ctype.h>\n"
398 buf += "#include <asm/unaligned.h>\n"
399 buf += "#include <scsi/scsi_common.h>\n"
400 buf += "#include <scsi/scsi_proto.h>\n"
401 buf += "#include <target/target_core_base.h>\n"
402 buf += "#include <target/target_core_fabric.h>\n"
403 buf += "#include \"" + fabric_mod_name + "_base.h\"\n"
404 buf += "#include \"" + fabric_mod_name + "_fabric.h\"\n\n"
405
406 buf += "int " + fabric_mod_name + "_check_true(struct se_portal_group *se_tpg)\n"
407 buf += "{\n"
408 buf += " return 1;\n"
409 buf += "}\n\n"
410 bufi += "int " + fabric_mod_name + "_check_true(struct se_portal_group *);\n"
411
412 buf += "int " + fabric_mod_name + "_check_false(struct se_portal_group *se_tpg)\n"
413 buf += "{\n"
414 buf += " return 0;\n"
415 buf += "}\n\n"
416 bufi += "int " + fabric_mod_name + "_check_false(struct se_portal_group *);\n"
417
418 total_fabric_ops = len(fabric_ops)
419 i = 0
420
421 while i < total_fabric_ops:
422 fo = fabric_ops[i]
423 i += 1
424# print "fabric_ops: " + fo
425
426 if re.search('get_fabric_name', fo):
427 buf += "char *" + fabric_mod_name + "_get_fabric_name(void)\n"
428 buf += "{\n"
429 buf += " return \"" + fabric_mod_name + "\";\n"
430 buf += "}\n\n"
431 bufi += "char *" + fabric_mod_name + "_get_fabric_name(void);\n"
432 continue
433
434 if re.search('get_wwn', fo):
435 buf += "char *" + fabric_mod_name + "_get_fabric_wwn(struct se_portal_group *se_tpg)\n"
436 buf += "{\n"
437 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
438 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
439 buf += " struct " + fabric_mod_name + "_" + fabric_mod_port + " *" + fabric_mod_port + " = tpg->" + fabric_mod_port + ";\n\n"
440 buf += " return &" + fabric_mod_port + "->" + fabric_mod_port + "_name[0];\n"
441 buf += "}\n\n"
442 bufi += "char *" + fabric_mod_name + "_get_fabric_wwn(struct se_portal_group *);\n"
443
444 if re.search('get_tag', fo):
445 buf += "u16 " + fabric_mod_name + "_get_tag(struct se_portal_group *se_tpg)\n"
446 buf += "{\n"
447 buf += " struct " + fabric_mod_name + "_tpg *tpg = container_of(se_tpg,\n"
448 buf += " struct " + fabric_mod_name + "_tpg, se_tpg);\n"
449 buf += " return tpg->" + fabric_mod_port + "_tpgt;\n"
450 buf += "}\n\n"
451 bufi += "u16 " + fabric_mod_name + "_get_tag(struct se_portal_group *);\n"
452
453 if re.search('tpg_get_inst_index\)\(', fo):
454 buf += "u32 " + fabric_mod_name + "_tpg_get_inst_index(struct se_portal_group *se_tpg)\n"
455 buf += "{\n"
456 buf += " return 1;\n"
457 buf += "}\n\n"
458 bufi += "u32 " + fabric_mod_name + "_tpg_get_inst_index(struct se_portal_group *);\n"
459
460 if re.search('\*release_cmd\)\(', fo):
461 buf += "void " + fabric_mod_name + "_release_cmd(struct se_cmd *se_cmd)\n"
462 buf += "{\n"
463 buf += " return;\n"
464 buf += "}\n\n"
465 bufi += "void " + fabric_mod_name + "_release_cmd(struct se_cmd *);\n"
466
467 if re.search('sess_get_index\)\(', fo):
468 buf += "u32 " + fabric_mod_name + "_sess_get_index(struct se_session *se_sess)\n"
469 buf += "{\n"
470 buf += " return 0;\n"
471 buf += "}\n\n"
472 bufi += "u32 " + fabric_mod_name + "_sess_get_index(struct se_session *);\n"
473
474 if re.search('write_pending\)\(', fo):
475 buf += "int " + fabric_mod_name + "_write_pending(struct se_cmd *se_cmd)\n"
476 buf += "{\n"
477 buf += " return 0;\n"
478 buf += "}\n\n"
479 bufi += "int " + fabric_mod_name + "_write_pending(struct se_cmd *);\n"
480
481 if re.search('set_default_node_attributes\)\(', fo):
482 buf += "void " + fabric_mod_name + "_set_default_node_attrs(struct se_node_acl *nacl)\n"
483 buf += "{\n"
484 buf += " return;\n"
485 buf += "}\n\n"
486 bufi += "void " + fabric_mod_name + "_set_default_node_attrs(struct se_node_acl *);\n"
487
488 if re.search('get_cmd_state\)\(', fo):
489 buf += "int " + fabric_mod_name + "_get_cmd_state(struct se_cmd *se_cmd)\n"
490 buf += "{\n"
491 buf += " return 0;\n"
492 buf += "}\n\n"
493 bufi += "int " + fabric_mod_name + "_get_cmd_state(struct se_cmd *);\n"
494
495 if re.search('queue_data_in\)\(', fo):
496 buf += "int " + fabric_mod_name + "_queue_data_in(struct se_cmd *se_cmd)\n"
497 buf += "{\n"
498 buf += " return 0;\n"
499 buf += "}\n\n"
500 bufi += "int " + fabric_mod_name + "_queue_data_in(struct se_cmd *);\n"
501
502 if re.search('queue_status\)\(', fo):
503 buf += "int " + fabric_mod_name + "_queue_status(struct se_cmd *se_cmd)\n"
504 buf += "{\n"
505 buf += " return 0;\n"
506 buf += "}\n\n"
507 bufi += "int " + fabric_mod_name + "_queue_status(struct se_cmd *);\n"
508
509 if re.search('queue_tm_rsp\)\(', fo):
510 buf += "void " + fabric_mod_name + "_queue_tm_rsp(struct se_cmd *se_cmd)\n"
511 buf += "{\n"
512 buf += " return;\n"
513 buf += "}\n\n"
514 bufi += "void " + fabric_mod_name + "_queue_tm_rsp(struct se_cmd *);\n"
515
516 if re.search('aborted_task\)\(', fo):
517 buf += "void " + fabric_mod_name + "_aborted_task(struct se_cmd *se_cmd)\n"
518 buf += "{\n"
519 buf += " return;\n"
520 buf += "}\n\n"
521 bufi += "void " + fabric_mod_name + "_aborted_task(struct se_cmd *);\n"
522
523 ret = p.write(buf)
524 if ret:
525 tcm_mod_err("Unable to write f: " + f)
526
527 p.close()
528
529 ret = pi.write(bufi)
530 if ret:
531 tcm_mod_err("Unable to write fi: " + fi)
532
533 pi.close()
534 return
535
536def tcm_mod_build_kbuild(fabric_mod_dir_var, fabric_mod_name):
537
538 buf = ""
539 f = fabric_mod_dir_var + "/Makefile"
540 print "Writing file: " + f
541
542 p = open(f, 'w')
543 if not p:
544 tcm_mod_err("Unable to open file: " + f)
545
546 buf += fabric_mod_name + "-objs := " + fabric_mod_name + "_fabric.o \\\n"
547 buf += " " + fabric_mod_name + "_configfs.o\n"
548 buf += "obj-$(CONFIG_" + fabric_mod_name.upper() + ") += " + fabric_mod_name + ".o\n"
549
550 ret = p.write(buf)
551 if ret:
552 tcm_mod_err("Unable to write f: " + f)
553
554 p.close()
555 return
556
557def tcm_mod_build_kconfig(fabric_mod_dir_var, fabric_mod_name):
558
559 buf = ""
560 f = fabric_mod_dir_var + "/Kconfig"
561 print "Writing file: " + f
562
563 p = open(f, 'w')
564 if not p:
565 tcm_mod_err("Unable to open file: " + f)
566
567 buf = "config " + fabric_mod_name.upper() + "\n"
568 buf += " tristate \"" + fabric_mod_name.upper() + " fabric module\"\n"
569 buf += " depends on TARGET_CORE && CONFIGFS_FS\n"
570 buf += " default n\n"
571 buf += " help\n"
572 buf += " Say Y here to enable the " + fabric_mod_name.upper() + " fabric module\n"
573
574 ret = p.write(buf)
575 if ret:
576 tcm_mod_err("Unable to write f: " + f)
577
578 p.close()
579 return
580
581def tcm_mod_add_kbuild(tcm_dir, fabric_mod_name):
582 buf = "obj-$(CONFIG_" + fabric_mod_name.upper() + ") += " + fabric_mod_name.lower() + "/\n"
583 kbuild = tcm_dir + "/drivers/target/Makefile"
584
585 f = open(kbuild, 'a')
586 f.write(buf)
587 f.close()
588 return
589
590def tcm_mod_add_kconfig(tcm_dir, fabric_mod_name):
591 buf = "source \"drivers/target/" + fabric_mod_name.lower() + "/Kconfig\"\n"
592 kconfig = tcm_dir + "/drivers/target/Kconfig"
593
594 f = open(kconfig, 'a')
595 f.write(buf)
596 f.close()
597 return
598
599def main(modname, proto_ident):
600# proto_ident = "FC"
601# proto_ident = "SAS"
602# proto_ident = "iSCSI"
603
604 tcm_dir = os.getcwd();
605 tcm_dir += "/../../"
606 print "tcm_dir: " + tcm_dir
607 fabric_mod_name = modname
608 fabric_mod_dir = tcm_dir + "drivers/target/" + fabric_mod_name
609 print "Set fabric_mod_name: " + fabric_mod_name
610 print "Set fabric_mod_dir: " + fabric_mod_dir
611 print "Using proto_ident: " + proto_ident
612
613 if proto_ident != "FC" and proto_ident != "SAS" and proto_ident != "iSCSI":
614 print "Unsupported proto_ident: " + proto_ident
615 sys.exit(1)
616
617 ret = tcm_mod_create_module_subdir(fabric_mod_dir)
618 if ret:
619 print "tcm_mod_create_module_subdir() failed because module already exists!"
620 sys.exit(1)
621
622 tcm_mod_build_base_includes(proto_ident, fabric_mod_dir, fabric_mod_name)
623 tcm_mod_scan_fabric_ops(tcm_dir)
624 tcm_mod_dump_fabric_ops(proto_ident, fabric_mod_dir, fabric_mod_name)
625 tcm_mod_build_configfs(proto_ident, fabric_mod_dir, fabric_mod_name)
626 tcm_mod_build_kbuild(fabric_mod_dir, fabric_mod_name)
627 tcm_mod_build_kconfig(fabric_mod_dir, fabric_mod_name)
628
629 input = raw_input("Would you like to add " + fabric_mod_name + " to drivers/target/Makefile..? [yes,no]: ")
630 if input == "yes" or input == "y":
631 tcm_mod_add_kbuild(tcm_dir, fabric_mod_name)
632
633 input = raw_input("Would you like to add " + fabric_mod_name + " to drivers/target/Kconfig..? [yes,no]: ")
634 if input == "yes" or input == "y":
635 tcm_mod_add_kconfig(tcm_dir, fabric_mod_name)
636
637 return
638
639parser = optparse.OptionParser()
640parser.add_option('-m', '--modulename', help='Module name', dest='modname',
641 action='store', nargs=1, type='string')
642parser.add_option('-p', '--protoident', help='Protocol Ident', dest='protoident',
643 action='store', nargs=1, type='string')
644
645(opts, args) = parser.parse_args()
646
647mandatories = ['modname', 'protoident']
648for m in mandatories:
649 if not opts.__dict__[m]:
650 print "mandatory option is missing\n"
651 parser.print_help()
652 exit(-1)
653
654if __name__ == "__main__":
655
656 main(str(opts.modname), opts.protoident)