14ca9bc22SMauro Carvalho Chehab========================================= 24ca9bc22SMauro Carvalho ChehabThe TCM v4 fabric module script generator 34ca9bc22SMauro Carvalho Chehab========================================= 44ca9bc22SMauro Carvalho Chehab 54ca9bc22SMauro Carvalho ChehabGreetings all, 64ca9bc22SMauro Carvalho Chehab 74ca9bc22SMauro Carvalho ChehabThis document is intended to be a mini-HOWTO for using the tcm_mod_builder.py 84ca9bc22SMauro Carvalho Chehabscript to generate a brand new functional TCM v4 fabric .ko module of your very own, 94ca9bc22SMauro Carvalho Chehabthat once built can be immediately be loaded to start access the new TCM/ConfigFS 104ca9bc22SMauro Carvalho Chehabfabric skeleton, by simply using:: 114ca9bc22SMauro Carvalho Chehab 124ca9bc22SMauro Carvalho Chehab modprobe $TCM_NEW_MOD 134ca9bc22SMauro Carvalho Chehab mkdir -p /sys/kernel/config/target/$TCM_NEW_MOD 144ca9bc22SMauro Carvalho Chehab 154ca9bc22SMauro Carvalho ChehabThis script will create a new drivers/target/$TCM_NEW_MOD/, and will do the following 164ca9bc22SMauro Carvalho Chehab 174ca9bc22SMauro Carvalho Chehab 1) Generate new API callers for drivers/target/target_core_fabric_configs.c logic 184ca9bc22SMauro Carvalho Chehab ->make_tpg(), ->drop_tpg(), ->make_wwn(), ->drop_wwn(). These are created 194ca9bc22SMauro Carvalho Chehab into $TCM_NEW_MOD/$TCM_NEW_MOD_configfs.c 204ca9bc22SMauro Carvalho Chehab 2) Generate basic infrastructure for loading/unloading LKMs and TCM/ConfigFS fabric module 214ca9bc22SMauro Carvalho Chehab using a skeleton struct target_core_fabric_ops API template. 224ca9bc22SMauro Carvalho Chehab 3) Based on user defined T10 Proto_Ident for the new fabric module being built, 234ca9bc22SMauro Carvalho Chehab the TransportID / Initiator and Target WWPN related handlers for 244ca9bc22SMauro Carvalho Chehab SPC-3 persistent reservation are automatically generated in $TCM_NEW_MOD/$TCM_NEW_MOD_fabric.c 254ca9bc22SMauro Carvalho Chehab using drivers/target/target_core_fabric_lib.c logic. 264ca9bc22SMauro Carvalho Chehab 4) NOP API calls for all other Data I/O path and fabric dependent attribute logic 274ca9bc22SMauro Carvalho Chehab in $TCM_NEW_MOD/$TCM_NEW_MOD_fabric.c 284ca9bc22SMauro Carvalho Chehab 294ca9bc22SMauro Carvalho Chehabtcm_mod_builder.py depends upon the mandatory '-p $PROTO_IDENT' and '-m 304ca9bc22SMauro Carvalho Chehab$FABRIC_MOD_name' parameters, and actually running the script looks like:: 314ca9bc22SMauro Carvalho Chehab 324ca9bc22SMauro Carvalho Chehab target:/mnt/sdb/lio-core-2.6.git/Documentation/target# python tcm_mod_builder.py -p iSCSI -m tcm_nab5000 334ca9bc22SMauro Carvalho Chehab tcm_dir: /mnt/sdb/lio-core-2.6.git/Documentation/target/../../ 344ca9bc22SMauro Carvalho Chehab Set fabric_mod_name: tcm_nab5000 354ca9bc22SMauro Carvalho Chehab Set fabric_mod_dir: 364ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000 374ca9bc22SMauro Carvalho Chehab Using proto_ident: iSCSI 384ca9bc22SMauro Carvalho Chehab Creating fabric_mod_dir: 394ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000 404ca9bc22SMauro Carvalho Chehab Writing file: 414ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_base.h 424ca9bc22SMauro Carvalho Chehab Using tcm_mod_scan_fabric_ops: 434ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../include/target/target_core_fabric_ops.h 444ca9bc22SMauro Carvalho Chehab Writing file: 454ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_fabric.c 464ca9bc22SMauro Carvalho Chehab Writing file: 474ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_fabric.h 484ca9bc22SMauro Carvalho Chehab Writing file: 494ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_configfs.c 504ca9bc22SMauro Carvalho Chehab Writing file: 514ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/Kbuild 524ca9bc22SMauro Carvalho Chehab Writing file: 534ca9bc22SMauro Carvalho Chehab /mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/Kconfig 544ca9bc22SMauro Carvalho Chehab Would you like to add tcm_nab5000to drivers/target/Kbuild..? [yes,no]: yes 554ca9bc22SMauro Carvalho Chehab Would you like to add tcm_nab5000to drivers/target/Kconfig..? [yes,no]: yes 564ca9bc22SMauro Carvalho Chehab 574ca9bc22SMauro Carvalho ChehabAt the end of tcm_mod_builder.py. the script will ask to add the following 584ca9bc22SMauro Carvalho Chehabline to drivers/target/Kbuild:: 594ca9bc22SMauro Carvalho Chehab 604ca9bc22SMauro Carvalho Chehab obj-$(CONFIG_TCM_NAB5000) += tcm_nab5000/ 614ca9bc22SMauro Carvalho Chehab 624ca9bc22SMauro Carvalho Chehaband the same for drivers/target/Kconfig:: 634ca9bc22SMauro Carvalho Chehab 644ca9bc22SMauro Carvalho Chehab source "drivers/target/tcm_nab5000/Kconfig" 654ca9bc22SMauro Carvalho Chehab 664ca9bc22SMauro Carvalho Chehab#) Run 'make menuconfig' and select the new CONFIG_TCM_NAB5000 item:: 674ca9bc22SMauro Carvalho Chehab 684ca9bc22SMauro Carvalho Chehab <M> TCM_NAB5000 fabric module 694ca9bc22SMauro Carvalho Chehab 704ca9bc22SMauro Carvalho Chehab#) Build using 'make modules', once completed you will have:: 714ca9bc22SMauro Carvalho Chehab 724ca9bc22SMauro Carvalho Chehab target:/mnt/sdb/lio-core-2.6.git# ls -la drivers/target/tcm_nab5000/ 734ca9bc22SMauro Carvalho Chehab total 1348 744ca9bc22SMauro Carvalho Chehab drwxr-xr-x 2 root root 4096 2010-10-05 03:23 . 754ca9bc22SMauro Carvalho Chehab drwxr-xr-x 9 root root 4096 2010-10-05 03:22 .. 764ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 282 2010-10-05 03:22 Kbuild 774ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 171 2010-10-05 03:22 Kconfig 784ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 49 2010-10-05 03:23 modules.order 794ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 738 2010-10-05 03:22 tcm_nab5000_base.h 804ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 9096 2010-10-05 03:22 tcm_nab5000_configfs.c 814ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 191200 2010-10-05 03:23 tcm_nab5000_configfs.o 824ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 40504 2010-10-05 03:23 .tcm_nab5000_configfs.o.cmd 834ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 5414 2010-10-05 03:22 tcm_nab5000_fabric.c 844ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 2016 2010-10-05 03:22 tcm_nab5000_fabric.h 854ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 190932 2010-10-05 03:23 tcm_nab5000_fabric.o 864ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 40713 2010-10-05 03:23 .tcm_nab5000_fabric.o.cmd 874ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 401861 2010-10-05 03:23 tcm_nab5000.ko 884ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 265 2010-10-05 03:23 .tcm_nab5000.ko.cmd 894ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 459 2010-10-05 03:23 tcm_nab5000.mod.c 904ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 23896 2010-10-05 03:23 tcm_nab5000.mod.o 914ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 22655 2010-10-05 03:23 .tcm_nab5000.mod.o.cmd 924ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 379022 2010-10-05 03:23 tcm_nab5000.o 934ca9bc22SMauro Carvalho Chehab -rw-r--r-- 1 root root 211 2010-10-05 03:23 .tcm_nab5000.o.cmd 944ca9bc22SMauro Carvalho Chehab 954ca9bc22SMauro Carvalho Chehab#) Load the new module, create a lun_0 configfs group, and add new TCM Core 964ca9bc22SMauro Carvalho Chehab IBLOCK backstore symlink to port:: 974ca9bc22SMauro Carvalho Chehab 984ca9bc22SMauro Carvalho Chehab target:/mnt/sdb/lio-core-2.6.git# insmod drivers/target/tcm_nab5000.ko 994ca9bc22SMauro Carvalho Chehab target:/mnt/sdb/lio-core-2.6.git# mkdir -p /sys/kernel/config/target/nab5000/iqn.foo/tpgt_1/lun/lun_0 1004ca9bc22SMauro Carvalho Chehab target:/mnt/sdb/lio-core-2.6.git# cd /sys/kernel/config/target/nab5000/iqn.foo/tpgt_1/lun/lun_0/ 1014ca9bc22SMauro Carvalho Chehab target:/sys/kernel/config/target/nab5000/iqn.foo/tpgt_1/lun/lun_0# ln -s /sys/kernel/config/target/core/iblock_0/lvm_test0 nab5000_port 1024ca9bc22SMauro Carvalho Chehab 1034ca9bc22SMauro Carvalho Chehab target:/sys/kernel/config/target/nab5000/iqn.foo/tpgt_1/lun/lun_0# cd - 1044ca9bc22SMauro Carvalho Chehab target:/mnt/sdb/lio-core-2.6.git# tree /sys/kernel/config/target/nab5000/ 1054ca9bc22SMauro Carvalho Chehab /sys/kernel/config/target/nab5000/ 1064ca9bc22SMauro Carvalho Chehab |-- discovery_auth 1074ca9bc22SMauro Carvalho Chehab |-- iqn.foo 1084ca9bc22SMauro Carvalho Chehab | `-- tpgt_1 1094ca9bc22SMauro Carvalho Chehab | |-- acls 1104ca9bc22SMauro Carvalho Chehab | |-- attrib 1114ca9bc22SMauro Carvalho Chehab | |-- lun 1124ca9bc22SMauro Carvalho Chehab | | `-- lun_0 1134ca9bc22SMauro Carvalho Chehab | | |-- alua_tg_pt_gp 1144ca9bc22SMauro Carvalho Chehab | | |-- alua_tg_pt_offline 1154ca9bc22SMauro Carvalho Chehab | | |-- alua_tg_pt_status 1164ca9bc22SMauro Carvalho Chehab | | |-- alua_tg_pt_write_md 1174ca9bc22SMauro Carvalho Chehab | | `-- nab5000_port -> ../../../../../../target/core/iblock_0/lvm_test0 1184ca9bc22SMauro Carvalho Chehab | |-- np 1194ca9bc22SMauro Carvalho Chehab | `-- param 1204ca9bc22SMauro Carvalho Chehab `-- version 1214ca9bc22SMauro Carvalho Chehab 1224ca9bc22SMauro Carvalho Chehab target:/mnt/sdb/lio-core-2.6.git# lsmod 1234ca9bc22SMauro Carvalho Chehab Module Size Used by 1244ca9bc22SMauro Carvalho Chehab tcm_nab5000 3935 4 1254ca9bc22SMauro Carvalho Chehab iscsi_target_mod 193211 0 1264ca9bc22SMauro Carvalho Chehab target_core_stgt 8090 0 1274ca9bc22SMauro Carvalho Chehab target_core_pscsi 11122 1 1284ca9bc22SMauro Carvalho Chehab target_core_file 9172 2 1294ca9bc22SMauro Carvalho Chehab target_core_iblock 9280 1 1304ca9bc22SMauro Carvalho Chehab target_core_mod 228575 31 1314ca9bc22SMauro Carvalho Chehab tcm_nab5000,iscsi_target_mod,target_core_stgt,target_core_pscsi,target_core_file,target_core_iblock 1324ca9bc22SMauro Carvalho Chehab libfc 73681 0 1334ca9bc22SMauro Carvalho Chehab scsi_debug 56265 0 1344ca9bc22SMauro Carvalho Chehab scsi_tgt 8666 1 target_core_stgt 1354ca9bc22SMauro Carvalho Chehab configfs 20644 2 target_core_mod 1364ca9bc22SMauro Carvalho Chehab 1374ca9bc22SMauro Carvalho Chehab---------------------------------------------------------------------- 1384ca9bc22SMauro Carvalho Chehab 1394ca9bc22SMauro Carvalho ChehabFuture TODO items 1404ca9bc22SMauro Carvalho Chehab================= 1414ca9bc22SMauro Carvalho Chehab 1424ca9bc22SMauro Carvalho Chehab 1) Add more T10 proto_idents 1434ca9bc22SMauro Carvalho Chehab 2) Make tcm_mod_dump_fabric_ops() smarter and generate function pointer 1444ca9bc22SMauro Carvalho Chehab defs directly from include/target/target_core_fabric_ops.h:struct target_core_fabric_ops 1454ca9bc22SMauro Carvalho Chehab structure members. 1464ca9bc22SMauro Carvalho Chehab 1474ca9bc22SMauro Carvalho ChehabOctober 5th, 2010 1484ca9bc22SMauro Carvalho Chehab 1494ca9bc22SMauro Carvalho ChehabNicholas A. Bellinger <nab@linux-iscsi.org> 150