tcm_loop.c 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535
  1. /*******************************************************************************
  2. *
  3. * This file contains the Linux/SCSI LLD virtual SCSI initiator driver
  4. * for emulated SAS initiator ports
  5. *
  6. * © Copyright 2011 RisingTide Systems LLC.
  7. *
  8. * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
  9. *
  10. * Author: Nicholas A. Bellinger <nab@risingtidesystems.com>
  11. *
  12. * This program is free software; you can redistribute it and/or modify
  13. * it under the terms of the GNU General Public License as published by
  14. * the Free Software Foundation; either version 2 of the License, or
  15. * (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU General Public License for more details.
  21. ****************************************************************************/
  22. #include <linux/module.h>
  23. #include <linux/moduleparam.h>
  24. #include <linux/init.h>
  25. #include <linux/slab.h>
  26. #include <linux/types.h>
  27. #include <linux/configfs.h>
  28. #include <scsi/scsi.h>
  29. #include <scsi/scsi_tcq.h>
  30. #include <scsi/scsi_host.h>
  31. #include <scsi/scsi_device.h>
  32. #include <scsi/scsi_cmnd.h>
  33. #include <target/target_core_base.h>
  34. #include <target/target_core_fabric.h>
  35. #include <target/target_core_fabric_configfs.h>
  36. #include <target/target_core_configfs.h>
  37. #include "tcm_loop.h"
  38. #define to_tcm_loop_hba(hba) container_of(hba, struct tcm_loop_hba, dev)
  39. /* Local pointer to allocated TCM configfs fabric module */
  40. static struct target_fabric_configfs *tcm_loop_fabric_configfs;
  41. static struct kmem_cache *tcm_loop_cmd_cache;
  42. static int tcm_loop_hba_no_cnt;
  43. /*
  44. * Allocate a tcm_loop cmd descriptor from target_core_mod code
  45. *
  46. * Can be called from interrupt context in tcm_loop_queuecommand() below
  47. */
  48. static struct se_cmd *tcm_loop_allocate_core_cmd(
  49. struct tcm_loop_hba *tl_hba,
  50. struct se_portal_group *se_tpg,
  51. struct scsi_cmnd *sc)
  52. {
  53. struct se_cmd *se_cmd;
  54. struct se_session *se_sess;
  55. struct tcm_loop_nexus *tl_nexus = tl_hba->tl_nexus;
  56. struct tcm_loop_cmd *tl_cmd;
  57. int sam_task_attr;
  58. if (!tl_nexus) {
  59. scmd_printk(KERN_ERR, sc, "TCM_Loop I_T Nexus"
  60. " does not exist\n");
  61. set_host_byte(sc, DID_ERROR);
  62. return NULL;
  63. }
  64. se_sess = tl_nexus->se_sess;
  65. tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC);
  66. if (!tl_cmd) {
  67. pr_err("Unable to allocate struct tcm_loop_cmd\n");
  68. set_host_byte(sc, DID_ERROR);
  69. return NULL;
  70. }
  71. se_cmd = &tl_cmd->tl_se_cmd;
  72. /*
  73. * Save the pointer to struct scsi_cmnd *sc
  74. */
  75. tl_cmd->sc = sc;
  76. /*
  77. * Locate the SAM Task Attr from struct scsi_cmnd *
  78. */
  79. if (sc->device->tagged_supported) {
  80. switch (sc->tag) {
  81. case HEAD_OF_QUEUE_TAG:
  82. sam_task_attr = MSG_HEAD_TAG;
  83. break;
  84. case ORDERED_QUEUE_TAG:
  85. sam_task_attr = MSG_ORDERED_TAG;
  86. break;
  87. default:
  88. sam_task_attr = MSG_SIMPLE_TAG;
  89. break;
  90. }
  91. } else
  92. sam_task_attr = MSG_SIMPLE_TAG;
  93. /*
  94. * Initialize struct se_cmd descriptor from target_core_mod infrastructure
  95. */
  96. transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess,
  97. scsi_bufflen(sc), sc->sc_data_direction, sam_task_attr,
  98. &tl_cmd->tl_sense_buf[0]);
  99. if (scsi_bidi_cmnd(sc))
  100. se_cmd->se_cmd_flags |= SCF_BIDI;
  101. /*
  102. * Locate the struct se_lun pointer and attach it to struct se_cmd
  103. */
  104. if (transport_lookup_cmd_lun(se_cmd, tl_cmd->sc->device->lun) < 0) {
  105. kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
  106. set_host_byte(sc, DID_NO_CONNECT);
  107. return NULL;
  108. }
  109. return se_cmd;
  110. }
  111. /*
  112. * Called by struct target_core_fabric_ops->new_cmd_map()
  113. *
  114. * Always called in process context. A non zero return value
  115. * here will signal to handle an exception based on the return code.
  116. */
  117. static int tcm_loop_new_cmd_map(struct se_cmd *se_cmd)
  118. {
  119. struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
  120. struct tcm_loop_cmd, tl_se_cmd);
  121. struct scsi_cmnd *sc = tl_cmd->sc;
  122. struct scatterlist *sgl_bidi = NULL;
  123. u32 sgl_bidi_count = 0;
  124. int ret;
  125. /*
  126. * Allocate the necessary tasks to complete the received CDB+data
  127. */
  128. ret = transport_generic_allocate_tasks(se_cmd, sc->cmnd);
  129. if (ret != 0)
  130. return ret;
  131. /*
  132. * For BIDI commands, pass in the extra READ buffer
  133. * to transport_generic_map_mem_to_cmd() below..
  134. */
  135. if (se_cmd->se_cmd_flags & SCF_BIDI) {
  136. struct scsi_data_buffer *sdb = scsi_in(sc);
  137. sgl_bidi = sdb->table.sgl;
  138. sgl_bidi_count = sdb->table.nents;
  139. }
  140. /*
  141. * Because some userspace code via scsi-generic do not memset their
  142. * associated read buffers, go ahead and do that here for type
  143. * SCF_SCSI_CONTROL_SG_IO_CDB. Also note that this is currently
  144. * guaranteed to be a single SGL for SCF_SCSI_CONTROL_SG_IO_CDB
  145. * by target core in transport_generic_allocate_tasks() ->
  146. * transport_generic_cmd_sequencer().
  147. */
  148. if (se_cmd->se_cmd_flags & SCF_SCSI_CONTROL_SG_IO_CDB &&
  149. se_cmd->data_direction == DMA_FROM_DEVICE) {
  150. struct scatterlist *sg = scsi_sglist(sc);
  151. unsigned char *buf = kmap(sg_page(sg)) + sg->offset;
  152. if (buf != NULL) {
  153. memset(buf, 0, sg->length);
  154. kunmap(sg_page(sg));
  155. }
  156. }
  157. /* Tell the core about our preallocated memory */
  158. return transport_generic_map_mem_to_cmd(se_cmd, scsi_sglist(sc),
  159. scsi_sg_count(sc), sgl_bidi, sgl_bidi_count);
  160. }
  161. /*
  162. * Called from struct target_core_fabric_ops->check_stop_free()
  163. */
  164. static int tcm_loop_check_stop_free(struct se_cmd *se_cmd)
  165. {
  166. /*
  167. * Do not release struct se_cmd's containing a valid TMR
  168. * pointer. These will be released directly in tcm_loop_device_reset()
  169. * with transport_generic_free_cmd().
  170. */
  171. if (se_cmd->se_tmr_req)
  172. return 0;
  173. /*
  174. * Release the struct se_cmd, which will make a callback to release
  175. * struct tcm_loop_cmd * in tcm_loop_deallocate_core_cmd()
  176. */
  177. transport_generic_free_cmd(se_cmd, 0);
  178. return 1;
  179. }
  180. static void tcm_loop_release_cmd(struct se_cmd *se_cmd)
  181. {
  182. struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
  183. struct tcm_loop_cmd, tl_se_cmd);
  184. kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
  185. }
  186. static int tcm_loop_proc_info(struct Scsi_Host *host, char *buffer,
  187. char **start, off_t offset,
  188. int length, int inout)
  189. {
  190. return sprintf(buffer, "tcm_loop_proc_info()\n");
  191. }
  192. static int tcm_loop_driver_probe(struct device *);
  193. static int tcm_loop_driver_remove(struct device *);
  194. static int pseudo_lld_bus_match(struct device *dev,
  195. struct device_driver *dev_driver)
  196. {
  197. return 1;
  198. }
  199. static struct bus_type tcm_loop_lld_bus = {
  200. .name = "tcm_loop_bus",
  201. .match = pseudo_lld_bus_match,
  202. .probe = tcm_loop_driver_probe,
  203. .remove = tcm_loop_driver_remove,
  204. };
  205. static struct device_driver tcm_loop_driverfs = {
  206. .name = "tcm_loop",
  207. .bus = &tcm_loop_lld_bus,
  208. };
  209. /*
  210. * Used with root_device_register() in tcm_loop_alloc_core_bus() below
  211. */
  212. struct device *tcm_loop_primary;
  213. /*
  214. * Copied from drivers/scsi/libfc/fc_fcp.c:fc_change_queue_depth() and
  215. * drivers/scsi/libiscsi.c:iscsi_change_queue_depth()
  216. */
  217. static int tcm_loop_change_queue_depth(
  218. struct scsi_device *sdev,
  219. int depth,
  220. int reason)
  221. {
  222. switch (reason) {
  223. case SCSI_QDEPTH_DEFAULT:
  224. scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
  225. break;
  226. case SCSI_QDEPTH_QFULL:
  227. scsi_track_queue_full(sdev, depth);
  228. break;
  229. case SCSI_QDEPTH_RAMP_UP:
  230. scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
  231. break;
  232. default:
  233. return -EOPNOTSUPP;
  234. }
  235. return sdev->queue_depth;
  236. }
  237. /*
  238. * Main entry point from struct scsi_host_template for incoming SCSI CDB+Data
  239. * from Linux/SCSI subsystem for SCSI low level device drivers (LLDs)
  240. */
  241. static int tcm_loop_queuecommand(
  242. struct Scsi_Host *sh,
  243. struct scsi_cmnd *sc)
  244. {
  245. struct se_cmd *se_cmd;
  246. struct se_portal_group *se_tpg;
  247. struct tcm_loop_hba *tl_hba;
  248. struct tcm_loop_tpg *tl_tpg;
  249. pr_debug("tcm_loop_queuecommand() %d:%d:%d:%d got CDB: 0x%02x"
  250. " scsi_buf_len: %u\n", sc->device->host->host_no,
  251. sc->device->id, sc->device->channel, sc->device->lun,
  252. sc->cmnd[0], scsi_bufflen(sc));
  253. /*
  254. * Locate the tcm_loop_hba_t pointer
  255. */
  256. tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
  257. tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
  258. /*
  259. * Ensure that this tl_tpg reference from the incoming sc->device->id
  260. * has already been configured via tcm_loop_make_naa_tpg().
  261. */
  262. if (!tl_tpg->tl_hba) {
  263. set_host_byte(sc, DID_NO_CONNECT);
  264. sc->scsi_done(sc);
  265. return 0;
  266. }
  267. se_tpg = &tl_tpg->tl_se_tpg;
  268. /*
  269. * Determine the SAM Task Attribute and allocate tl_cmd and
  270. * tl_cmd->tl_se_cmd from TCM infrastructure
  271. */
  272. se_cmd = tcm_loop_allocate_core_cmd(tl_hba, se_tpg, sc);
  273. if (!se_cmd) {
  274. sc->scsi_done(sc);
  275. return 0;
  276. }
  277. /*
  278. * Queue up the newly allocated to be processed in TCM thread context.
  279. */
  280. transport_generic_handle_cdb_map(se_cmd);
  281. return 0;
  282. }
  283. /*
  284. * Called from SCSI EH process context to issue a LUN_RESET TMR
  285. * to struct scsi_device
  286. */
  287. static int tcm_loop_device_reset(struct scsi_cmnd *sc)
  288. {
  289. struct se_cmd *se_cmd = NULL;
  290. struct se_portal_group *se_tpg;
  291. struct se_session *se_sess;
  292. struct tcm_loop_cmd *tl_cmd = NULL;
  293. struct tcm_loop_hba *tl_hba;
  294. struct tcm_loop_nexus *tl_nexus;
  295. struct tcm_loop_tmr *tl_tmr = NULL;
  296. struct tcm_loop_tpg *tl_tpg;
  297. int ret = FAILED;
  298. /*
  299. * Locate the tcm_loop_hba_t pointer
  300. */
  301. tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
  302. /*
  303. * Locate the tl_nexus and se_sess pointers
  304. */
  305. tl_nexus = tl_hba->tl_nexus;
  306. if (!tl_nexus) {
  307. pr_err("Unable to perform device reset without"
  308. " active I_T Nexus\n");
  309. return FAILED;
  310. }
  311. se_sess = tl_nexus->se_sess;
  312. /*
  313. * Locate the tl_tpg and se_tpg pointers from TargetID in sc->device->id
  314. */
  315. tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
  316. se_tpg = &tl_tpg->tl_se_tpg;
  317. tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL);
  318. if (!tl_cmd) {
  319. pr_err("Unable to allocate memory for tl_cmd\n");
  320. return FAILED;
  321. }
  322. tl_tmr = kzalloc(sizeof(struct tcm_loop_tmr), GFP_KERNEL);
  323. if (!tl_tmr) {
  324. pr_err("Unable to allocate memory for tl_tmr\n");
  325. goto release;
  326. }
  327. init_waitqueue_head(&tl_tmr->tl_tmr_wait);
  328. se_cmd = &tl_cmd->tl_se_cmd;
  329. /*
  330. * Initialize struct se_cmd descriptor from target_core_mod infrastructure
  331. */
  332. transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess, 0,
  333. DMA_NONE, MSG_SIMPLE_TAG,
  334. &tl_cmd->tl_sense_buf[0]);
  335. /*
  336. * Allocate the LUN_RESET TMR
  337. */
  338. se_cmd->se_tmr_req = core_tmr_alloc_req(se_cmd, tl_tmr,
  339. TMR_LUN_RESET, GFP_KERNEL);
  340. if (IS_ERR(se_cmd->se_tmr_req))
  341. goto release;
  342. /*
  343. * Locate the underlying TCM struct se_lun from sc->device->lun
  344. */
  345. if (transport_lookup_tmr_lun(se_cmd, sc->device->lun) < 0)
  346. goto release;
  347. /*
  348. * Queue the TMR to TCM Core and sleep waiting for tcm_loop_queue_tm_rsp()
  349. * to wake us up.
  350. */
  351. transport_generic_handle_tmr(se_cmd);
  352. wait_event(tl_tmr->tl_tmr_wait, atomic_read(&tl_tmr->tmr_complete));
  353. /*
  354. * The TMR LUN_RESET has completed, check the response status and
  355. * then release allocations.
  356. */
  357. ret = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
  358. SUCCESS : FAILED;
  359. release:
  360. if (se_cmd)
  361. transport_generic_free_cmd(se_cmd, 1);
  362. else
  363. kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
  364. kfree(tl_tmr);
  365. return ret;
  366. }
  367. static int tcm_loop_slave_alloc(struct scsi_device *sd)
  368. {
  369. set_bit(QUEUE_FLAG_BIDI, &sd->request_queue->queue_flags);
  370. return 0;
  371. }
  372. static int tcm_loop_slave_configure(struct scsi_device *sd)
  373. {
  374. return 0;
  375. }
  376. static struct scsi_host_template tcm_loop_driver_template = {
  377. .proc_info = tcm_loop_proc_info,
  378. .proc_name = "tcm_loopback",
  379. .name = "TCM_Loopback",
  380. .queuecommand = tcm_loop_queuecommand,
  381. .change_queue_depth = tcm_loop_change_queue_depth,
  382. .eh_device_reset_handler = tcm_loop_device_reset,
  383. .can_queue = TL_SCSI_CAN_QUEUE,
  384. .this_id = -1,
  385. .sg_tablesize = TL_SCSI_SG_TABLESIZE,
  386. .cmd_per_lun = TL_SCSI_CMD_PER_LUN,
  387. .max_sectors = TL_SCSI_MAX_SECTORS,
  388. .use_clustering = DISABLE_CLUSTERING,
  389. .slave_alloc = tcm_loop_slave_alloc,
  390. .slave_configure = tcm_loop_slave_configure,
  391. .module = THIS_MODULE,
  392. };
  393. static int tcm_loop_driver_probe(struct device *dev)
  394. {
  395. struct tcm_loop_hba *tl_hba;
  396. struct Scsi_Host *sh;
  397. int error;
  398. tl_hba = to_tcm_loop_hba(dev);
  399. sh = scsi_host_alloc(&tcm_loop_driver_template,
  400. sizeof(struct tcm_loop_hba));
  401. if (!sh) {
  402. pr_err("Unable to allocate struct scsi_host\n");
  403. return -ENODEV;
  404. }
  405. tl_hba->sh = sh;
  406. /*
  407. * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata
  408. */
  409. *((struct tcm_loop_hba **)sh->hostdata) = tl_hba;
  410. /*
  411. * Setup single ID, Channel and LUN for now..
  412. */
  413. sh->max_id = 2;
  414. sh->max_lun = 0;
  415. sh->max_channel = 0;
  416. sh->max_cmd_len = TL_SCSI_MAX_CMD_LEN;
  417. error = scsi_add_host(sh, &tl_hba->dev);
  418. if (error) {
  419. pr_err("%s: scsi_add_host failed\n", __func__);
  420. scsi_host_put(sh);
  421. return -ENODEV;
  422. }
  423. return 0;
  424. }
  425. static int tcm_loop_driver_remove(struct device *dev)
  426. {
  427. struct tcm_loop_hba *tl_hba;
  428. struct Scsi_Host *sh;
  429. tl_hba = to_tcm_loop_hba(dev);
  430. sh = tl_hba->sh;
  431. scsi_remove_host(sh);
  432. scsi_host_put(sh);
  433. return 0;
  434. }
  435. static void tcm_loop_release_adapter(struct device *dev)
  436. {
  437. struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev);
  438. kfree(tl_hba);
  439. }
  440. /*
  441. * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c
  442. */
  443. static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id)
  444. {
  445. int ret;
  446. tl_hba->dev.bus = &tcm_loop_lld_bus;
  447. tl_hba->dev.parent = tcm_loop_primary;
  448. tl_hba->dev.release = &tcm_loop_release_adapter;
  449. dev_set_name(&tl_hba->dev, "tcm_loop_adapter_%d", tcm_loop_host_id);
  450. ret = device_register(&tl_hba->dev);
  451. if (ret) {
  452. pr_err("device_register() failed for"
  453. " tl_hba->dev: %d\n", ret);
  454. return -ENODEV;
  455. }
  456. return 0;
  457. }
  458. /*
  459. * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated
  460. * tcm_loop SCSI bus.
  461. */
  462. static int tcm_loop_alloc_core_bus(void)
  463. {
  464. int ret;
  465. tcm_loop_primary = root_device_register("tcm_loop_0");
  466. if (IS_ERR(tcm_loop_primary)) {
  467. pr_err("Unable to allocate tcm_loop_primary\n");
  468. return PTR_ERR(tcm_loop_primary);
  469. }
  470. ret = bus_register(&tcm_loop_lld_bus);
  471. if (ret) {
  472. pr_err("bus_register() failed for tcm_loop_lld_bus\n");
  473. goto dev_unreg;
  474. }
  475. ret = driver_register(&tcm_loop_driverfs);
  476. if (ret) {
  477. pr_err("driver_register() failed for"
  478. "tcm_loop_driverfs\n");
  479. goto bus_unreg;
  480. }
  481. pr_debug("Initialized TCM Loop Core Bus\n");
  482. return ret;
  483. bus_unreg:
  484. bus_unregister(&tcm_loop_lld_bus);
  485. dev_unreg:
  486. root_device_unregister(tcm_loop_primary);
  487. return ret;
  488. }
  489. static void tcm_loop_release_core_bus(void)
  490. {
  491. driver_unregister(&tcm_loop_driverfs);
  492. bus_unregister(&tcm_loop_lld_bus);
  493. root_device_unregister(tcm_loop_primary);
  494. pr_debug("Releasing TCM Loop Core BUS\n");
  495. }
  496. static char *tcm_loop_get_fabric_name(void)
  497. {
  498. return "loopback";
  499. }
  500. static u8 tcm_loop_get_fabric_proto_ident(struct se_portal_group *se_tpg)
  501. {
  502. struct tcm_loop_tpg *tl_tpg =
  503. (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
  504. struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
  505. /*
  506. * tl_proto_id is set at tcm_loop_configfs.c:tcm_loop_make_scsi_hba()
  507. * time based on the protocol dependent prefix of the passed configfs group.
  508. *
  509. * Based upon tl_proto_id, TCM_Loop emulates the requested fabric
  510. * ProtocolID using target_core_fabric_lib.c symbols.
  511. */
  512. switch (tl_hba->tl_proto_id) {
  513. case SCSI_PROTOCOL_SAS:
  514. return sas_get_fabric_proto_ident(se_tpg);
  515. case SCSI_PROTOCOL_FCP:
  516. return fc_get_fabric_proto_ident(se_tpg);
  517. case SCSI_PROTOCOL_ISCSI:
  518. return iscsi_get_fabric_proto_ident(se_tpg);
  519. default:
  520. pr_err("Unknown tl_proto_id: 0x%02x, using"
  521. " SAS emulation\n", tl_hba->tl_proto_id);
  522. break;
  523. }
  524. return sas_get_fabric_proto_ident(se_tpg);
  525. }
  526. static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg)
  527. {
  528. struct tcm_loop_tpg *tl_tpg =
  529. (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
  530. /*
  531. * Return the passed NAA identifier for the SAS Target Port
  532. */
  533. return &tl_tpg->tl_hba->tl_wwn_address[0];
  534. }
  535. static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg)
  536. {
  537. struct tcm_loop_tpg *tl_tpg =
  538. (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
  539. /*
  540. * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83
  541. * to represent the SCSI Target Port.
  542. */
  543. return tl_tpg->tl_tpgt;
  544. }
  545. static u32 tcm_loop_get_default_depth(struct se_portal_group *se_tpg)
  546. {
  547. return 1;
  548. }
  549. static u32 tcm_loop_get_pr_transport_id(
  550. struct se_portal_group *se_tpg,
  551. struct se_node_acl *se_nacl,
  552. struct t10_pr_registration *pr_reg,
  553. int *format_code,
  554. unsigned char *buf)
  555. {
  556. struct tcm_loop_tpg *tl_tpg =
  557. (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
  558. struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
  559. switch (tl_hba->tl_proto_id) {
  560. case SCSI_PROTOCOL_SAS:
  561. return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
  562. format_code, buf);
  563. case SCSI_PROTOCOL_FCP:
  564. return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
  565. format_code, buf);
  566. case SCSI_PROTOCOL_ISCSI:
  567. return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
  568. format_code, buf);
  569. default:
  570. pr_err("Unknown tl_proto_id: 0x%02x, using"
  571. " SAS emulation\n", tl_hba->tl_proto_id);
  572. break;
  573. }
  574. return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
  575. format_code, buf);
  576. }
  577. static u32 tcm_loop_get_pr_transport_id_len(
  578. struct se_portal_group *se_tpg,
  579. struct se_node_acl *se_nacl,
  580. struct t10_pr_registration *pr_reg,
  581. int *format_code)
  582. {
  583. struct tcm_loop_tpg *tl_tpg =
  584. (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
  585. struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
  586. switch (tl_hba->tl_proto_id) {
  587. case SCSI_PROTOCOL_SAS:
  588. return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
  589. format_code);
  590. case SCSI_PROTOCOL_FCP:
  591. return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
  592. format_code);
  593. case SCSI_PROTOCOL_ISCSI:
  594. return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
  595. format_code);
  596. default:
  597. pr_err("Unknown tl_proto_id: 0x%02x, using"
  598. " SAS emulation\n", tl_hba->tl_proto_id);
  599. break;
  600. }
  601. return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
  602. format_code);
  603. }
  604. /*
  605. * Used for handling SCSI fabric dependent TransportIDs in SPC-3 and above
  606. * Persistent Reservation SPEC_I_PT=1 and PROUT REGISTER_AND_MOVE operations.
  607. */
  608. static char *tcm_loop_parse_pr_out_transport_id(
  609. struct se_portal_group *se_tpg,
  610. const char *buf,
  611. u32 *out_tid_len,
  612. char **port_nexus_ptr)
  613. {
  614. struct tcm_loop_tpg *tl_tpg =
  615. (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
  616. struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
  617. switch (tl_hba->tl_proto_id) {
  618. case SCSI_PROTOCOL_SAS:
  619. return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
  620. port_nexus_ptr);
  621. case SCSI_PROTOCOL_FCP:
  622. return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
  623. port_nexus_ptr);
  624. case SCSI_PROTOCOL_ISCSI:
  625. return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
  626. port_nexus_ptr);
  627. default:
  628. pr_err("Unknown tl_proto_id: 0x%02x, using"
  629. " SAS emulation\n", tl_hba->tl_proto_id);
  630. break;
  631. }
  632. return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
  633. port_nexus_ptr);
  634. }
  635. /*
  636. * Returning (1) here allows for target_core_mod struct se_node_acl to be generated
  637. * based upon the incoming fabric dependent SCSI Initiator Port
  638. */
  639. static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg)
  640. {
  641. return 1;
  642. }
  643. static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg)
  644. {
  645. return 0;
  646. }
  647. /*
  648. * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for
  649. * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest
  650. */
  651. static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg)
  652. {
  653. return 0;
  654. }
  655. /*
  656. * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will
  657. * never be called for TCM_Loop by target_core_fabric_configfs.c code.
  658. * It has been added here as a nop for target_fabric_tf_ops_check()
  659. */
  660. static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg)
  661. {
  662. return 0;
  663. }
  664. static struct se_node_acl *tcm_loop_tpg_alloc_fabric_acl(
  665. struct se_portal_group *se_tpg)
  666. {
  667. struct tcm_loop_nacl *tl_nacl;
  668. tl_nacl = kzalloc(sizeof(struct tcm_loop_nacl), GFP_KERNEL);
  669. if (!tl_nacl) {
  670. pr_err("Unable to allocate struct tcm_loop_nacl\n");
  671. return NULL;
  672. }
  673. return &tl_nacl->se_node_acl;
  674. }
  675. static void tcm_loop_tpg_release_fabric_acl(
  676. struct se_portal_group *se_tpg,
  677. struct se_node_acl *se_nacl)
  678. {
  679. struct tcm_loop_nacl *tl_nacl = container_of(se_nacl,
  680. struct tcm_loop_nacl, se_node_acl);
  681. kfree(tl_nacl);
  682. }
  683. static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg)
  684. {
  685. return 1;
  686. }
  687. static int tcm_loop_is_state_remove(struct se_cmd *se_cmd)
  688. {
  689. /*
  690. * Assume struct scsi_cmnd is not in remove state..
  691. */
  692. return 0;
  693. }
  694. static int tcm_loop_sess_logged_in(struct se_session *se_sess)
  695. {
  696. /*
  697. * Assume that TL Nexus is always active
  698. */
  699. return 1;
  700. }
  701. static u32 tcm_loop_sess_get_index(struct se_session *se_sess)
  702. {
  703. return 1;
  704. }
  705. static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl)
  706. {
  707. return;
  708. }
  709. static u32 tcm_loop_get_task_tag(struct se_cmd *se_cmd)
  710. {
  711. return 1;
  712. }
  713. static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd)
  714. {
  715. struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
  716. struct tcm_loop_cmd, tl_se_cmd);
  717. return tl_cmd->sc_cmd_state;
  718. }
  719. static int tcm_loop_shutdown_session(struct se_session *se_sess)
  720. {
  721. return 0;
  722. }
  723. static void tcm_loop_close_session(struct se_session *se_sess)
  724. {
  725. return;
  726. };
  727. static void tcm_loop_stop_session(
  728. struct se_session *se_sess,
  729. int sess_sleep,
  730. int conn_sleep)
  731. {
  732. return;
  733. }
  734. static void tcm_loop_fall_back_to_erl0(struct se_session *se_sess)
  735. {
  736. return;
  737. }
  738. static int tcm_loop_write_pending(struct se_cmd *se_cmd)
  739. {
  740. /*
  741. * Since Linux/SCSI has already sent down a struct scsi_cmnd
  742. * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array
  743. * memory, and memory has already been mapped to struct se_cmd->t_mem_list
  744. * format with transport_generic_map_mem_to_cmd().
  745. *
  746. * We now tell TCM to add this WRITE CDB directly into the TCM storage
  747. * object execution queue.
  748. */
  749. transport_generic_process_write(se_cmd);
  750. return 0;
  751. }
  752. static int tcm_loop_write_pending_status(struct se_cmd *se_cmd)
  753. {
  754. return 0;
  755. }
  756. static int tcm_loop_queue_data_in(struct se_cmd *se_cmd)
  757. {
  758. struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
  759. struct tcm_loop_cmd, tl_se_cmd);
  760. struct scsi_cmnd *sc = tl_cmd->sc;
  761. pr_debug("tcm_loop_queue_data_in() called for scsi_cmnd: %p"
  762. " cdb: 0x%02x\n", sc, sc->cmnd[0]);
  763. sc->result = SAM_STAT_GOOD;
  764. set_host_byte(sc, DID_OK);
  765. sc->scsi_done(sc);
  766. return 0;
  767. }
  768. static int tcm_loop_queue_status(struct se_cmd *se_cmd)
  769. {
  770. struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
  771. struct tcm_loop_cmd, tl_se_cmd);
  772. struct scsi_cmnd *sc = tl_cmd->sc;
  773. pr_debug("tcm_loop_queue_status() called for scsi_cmnd: %p"
  774. " cdb: 0x%02x\n", sc, sc->cmnd[0]);
  775. if (se_cmd->sense_buffer &&
  776. ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
  777. (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) {
  778. memcpy(sc->sense_buffer, se_cmd->sense_buffer,
  779. SCSI_SENSE_BUFFERSIZE);
  780. sc->result = SAM_STAT_CHECK_CONDITION;
  781. set_driver_byte(sc, DRIVER_SENSE);
  782. } else
  783. sc->result = se_cmd->scsi_status;
  784. set_host_byte(sc, DID_OK);
  785. sc->scsi_done(sc);
  786. return 0;
  787. }
  788. static int tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd)
  789. {
  790. struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
  791. struct tcm_loop_tmr *tl_tmr = se_tmr->fabric_tmr_ptr;
  792. /*
  793. * The SCSI EH thread will be sleeping on se_tmr->tl_tmr_wait, go ahead
  794. * and wake up the wait_queue_head_t in tcm_loop_device_reset()
  795. */
  796. atomic_set(&tl_tmr->tmr_complete, 1);
  797. wake_up(&tl_tmr->tl_tmr_wait);
  798. return 0;
  799. }
  800. static u16 tcm_loop_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_length)
  801. {
  802. return 0;
  803. }
  804. static u16 tcm_loop_get_fabric_sense_len(void)
  805. {
  806. return 0;
  807. }
  808. static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba)
  809. {
  810. switch (tl_hba->tl_proto_id) {
  811. case SCSI_PROTOCOL_SAS:
  812. return "SAS";
  813. case SCSI_PROTOCOL_FCP:
  814. return "FCP";
  815. case SCSI_PROTOCOL_ISCSI:
  816. return "iSCSI";
  817. default:
  818. break;
  819. }
  820. return "Unknown";
  821. }
  822. /* Start items for tcm_loop_port_cit */
  823. static int tcm_loop_port_link(
  824. struct se_portal_group *se_tpg,
  825. struct se_lun *lun)
  826. {
  827. struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
  828. struct tcm_loop_tpg, tl_se_tpg);
  829. struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
  830. atomic_inc(&tl_tpg->tl_tpg_port_count);
  831. smp_mb__after_atomic_inc();
  832. /*
  833. * Add Linux/SCSI struct scsi_device by HCTL
  834. */
  835. scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun);
  836. pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n");
  837. return 0;
  838. }
  839. static void tcm_loop_port_unlink(
  840. struct se_portal_group *se_tpg,
  841. struct se_lun *se_lun)
  842. {
  843. struct scsi_device *sd;
  844. struct tcm_loop_hba *tl_hba;
  845. struct tcm_loop_tpg *tl_tpg;
  846. tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
  847. tl_hba = tl_tpg->tl_hba;
  848. sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt,
  849. se_lun->unpacked_lun);
  850. if (!sd) {
  851. pr_err("Unable to locate struct scsi_device for %d:%d:"
  852. "%d\n", 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun);
  853. return;
  854. }
  855. /*
  856. * Remove Linux/SCSI struct scsi_device by HCTL
  857. */
  858. scsi_remove_device(sd);
  859. scsi_device_put(sd);
  860. atomic_dec(&tl_tpg->tl_tpg_port_count);
  861. smp_mb__after_atomic_dec();
  862. pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n");
  863. }
  864. /* End items for tcm_loop_port_cit */
  865. /* Start items for tcm_loop_nexus_cit */
  866. static int tcm_loop_make_nexus(
  867. struct tcm_loop_tpg *tl_tpg,
  868. const char *name)
  869. {
  870. struct se_portal_group *se_tpg;
  871. struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
  872. struct tcm_loop_nexus *tl_nexus;
  873. int ret = -ENOMEM;
  874. if (tl_tpg->tl_hba->tl_nexus) {
  875. pr_debug("tl_tpg->tl_hba->tl_nexus already exists\n");
  876. return -EEXIST;
  877. }
  878. se_tpg = &tl_tpg->tl_se_tpg;
  879. tl_nexus = kzalloc(sizeof(struct tcm_loop_nexus), GFP_KERNEL);
  880. if (!tl_nexus) {
  881. pr_err("Unable to allocate struct tcm_loop_nexus\n");
  882. return -ENOMEM;
  883. }
  884. /*
  885. * Initialize the struct se_session pointer
  886. */
  887. tl_nexus->se_sess = transport_init_session();
  888. if (IS_ERR(tl_nexus->se_sess)) {
  889. ret = PTR_ERR(tl_nexus->se_sess);
  890. goto out;
  891. }
  892. /*
  893. * Since we are running in 'demo mode' this call with generate a
  894. * struct se_node_acl for the tcm_loop struct se_portal_group with the SCSI
  895. * Initiator port name of the passed configfs group 'name'.
  896. */
  897. tl_nexus->se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
  898. se_tpg, (unsigned char *)name);
  899. if (!tl_nexus->se_sess->se_node_acl) {
  900. transport_free_session(tl_nexus->se_sess);
  901. goto out;
  902. }
  903. /*
  904. * Now, register the SAS I_T Nexus as active with the call to
  905. * transport_register_session()
  906. */
  907. __transport_register_session(se_tpg, tl_nexus->se_sess->se_node_acl,
  908. tl_nexus->se_sess, tl_nexus);
  909. tl_tpg->tl_hba->tl_nexus = tl_nexus;
  910. pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated"
  911. " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
  912. name);
  913. return 0;
  914. out:
  915. kfree(tl_nexus);
  916. return ret;
  917. }
  918. static int tcm_loop_drop_nexus(
  919. struct tcm_loop_tpg *tpg)
  920. {
  921. struct se_session *se_sess;
  922. struct tcm_loop_nexus *tl_nexus;
  923. struct tcm_loop_hba *tl_hba = tpg->tl_hba;
  924. tl_nexus = tpg->tl_hba->tl_nexus;
  925. if (!tl_nexus)
  926. return -ENODEV;
  927. se_sess = tl_nexus->se_sess;
  928. if (!se_sess)
  929. return -ENODEV;
  930. if (atomic_read(&tpg->tl_tpg_port_count)) {
  931. pr_err("Unable to remove TCM_Loop I_T Nexus with"
  932. " active TPG port count: %d\n",
  933. atomic_read(&tpg->tl_tpg_port_count));
  934. return -EPERM;
  935. }
  936. pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated"
  937. " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
  938. tl_nexus->se_sess->se_node_acl->initiatorname);
  939. /*
  940. * Release the SCSI I_T Nexus to the emulated SAS Target Port
  941. */
  942. transport_deregister_session(tl_nexus->se_sess);
  943. tpg->tl_hba->tl_nexus = NULL;
  944. kfree(tl_nexus);
  945. return 0;
  946. }
  947. /* End items for tcm_loop_nexus_cit */
  948. static ssize_t tcm_loop_tpg_show_nexus(
  949. struct se_portal_group *se_tpg,
  950. char *page)
  951. {
  952. struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
  953. struct tcm_loop_tpg, tl_se_tpg);
  954. struct tcm_loop_nexus *tl_nexus;
  955. ssize_t ret;
  956. tl_nexus = tl_tpg->tl_hba->tl_nexus;
  957. if (!tl_nexus)
  958. return -ENODEV;
  959. ret = snprintf(page, PAGE_SIZE, "%s\n",
  960. tl_nexus->se_sess->se_node_acl->initiatorname);
  961. return ret;
  962. }
  963. static ssize_t tcm_loop_tpg_store_nexus(
  964. struct se_portal_group *se_tpg,
  965. const char *page,
  966. size_t count)
  967. {
  968. struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
  969. struct tcm_loop_tpg, tl_se_tpg);
  970. struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
  971. unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr;
  972. int ret;
  973. /*
  974. * Shutdown the active I_T nexus if 'NULL' is passed..
  975. */
  976. if (!strncmp(page, "NULL", 4)) {
  977. ret = tcm_loop_drop_nexus(tl_tpg);
  978. return (!ret) ? count : ret;
  979. }
  980. /*
  981. * Otherwise make sure the passed virtual Initiator port WWN matches
  982. * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call
  983. * tcm_loop_make_nexus()
  984. */
  985. if (strlen(page) >= TL_WWN_ADDR_LEN) {
  986. pr_err("Emulated NAA Sas Address: %s, exceeds"
  987. " max: %d\n", page, TL_WWN_ADDR_LEN);
  988. return -EINVAL;
  989. }
  990. snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page);
  991. ptr = strstr(i_port, "naa.");
  992. if (ptr) {
  993. if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) {
  994. pr_err("Passed SAS Initiator Port %s does not"
  995. " match target port protoid: %s\n", i_port,
  996. tcm_loop_dump_proto_id(tl_hba));
  997. return -EINVAL;
  998. }
  999. port_ptr = &i_port[0];
  1000. goto check_newline;
  1001. }
  1002. ptr = strstr(i_port, "fc.");
  1003. if (ptr) {
  1004. if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) {
  1005. pr_err("Passed FCP Initiator Port %s does not"
  1006. " match target port protoid: %s\n", i_port,
  1007. tcm_loop_dump_proto_id(tl_hba));
  1008. return -EINVAL;
  1009. }
  1010. port_ptr = &i_port[3]; /* Skip over "fc." */
  1011. goto check_newline;
  1012. }
  1013. ptr = strstr(i_port, "iqn.");
  1014. if (ptr) {
  1015. if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) {
  1016. pr_err("Passed iSCSI Initiator Port %s does not"
  1017. " match target port protoid: %s\n", i_port,
  1018. tcm_loop_dump_proto_id(tl_hba));
  1019. return -EINVAL;
  1020. }
  1021. port_ptr = &i_port[0];
  1022. goto check_newline;
  1023. }
  1024. pr_err("Unable to locate prefix for emulated Initiator Port:"
  1025. " %s\n", i_port);
  1026. return -EINVAL;
  1027. /*
  1028. * Clear any trailing newline for the NAA WWN
  1029. */
  1030. check_newline:
  1031. if (i_port[strlen(i_port)-1] == '\n')
  1032. i_port[strlen(i_port)-1] = '\0';
  1033. ret = tcm_loop_make_nexus(tl_tpg, port_ptr);
  1034. if (ret < 0)
  1035. return ret;
  1036. return count;
  1037. }
  1038. TF_TPG_BASE_ATTR(tcm_loop, nexus, S_IRUGO | S_IWUSR);
  1039. static struct configfs_attribute *tcm_loop_tpg_attrs[] = {
  1040. &tcm_loop_tpg_nexus.attr,
  1041. NULL,
  1042. };
  1043. /* Start items for tcm_loop_naa_cit */
  1044. struct se_portal_group *tcm_loop_make_naa_tpg(
  1045. struct se_wwn *wwn,
  1046. struct config_group *group,
  1047. const char *name)
  1048. {
  1049. struct tcm_loop_hba *tl_hba = container_of(wwn,
  1050. struct tcm_loop_hba, tl_hba_wwn);
  1051. struct tcm_loop_tpg *tl_tpg;
  1052. char *tpgt_str, *end_ptr;
  1053. int ret;
  1054. unsigned short int tpgt;
  1055. tpgt_str = strstr(name, "tpgt_");
  1056. if (!tpgt_str) {
  1057. pr_err("Unable to locate \"tpgt_#\" directory"
  1058. " group\n");
  1059. return ERR_PTR(-EINVAL);
  1060. }
  1061. tpgt_str += 5; /* Skip ahead of "tpgt_" */
  1062. tpgt = (unsigned short int) simple_strtoul(tpgt_str, &end_ptr, 0);
  1063. if (tpgt >= TL_TPGS_PER_HBA) {
  1064. pr_err("Passed tpgt: %hu exceeds TL_TPGS_PER_HBA:"
  1065. " %u\n", tpgt, TL_TPGS_PER_HBA);
  1066. return ERR_PTR(-EINVAL);
  1067. }
  1068. tl_tpg = &tl_hba->tl_hba_tpgs[tpgt];
  1069. tl_tpg->tl_hba = tl_hba;
  1070. tl_tpg->tl_tpgt = tpgt;
  1071. /*
  1072. * Register the tl_tpg as a emulated SAS TCM Target Endpoint
  1073. */
  1074. ret = core_tpg_register(&tcm_loop_fabric_configfs->tf_ops,
  1075. wwn, &tl_tpg->tl_se_tpg, tl_tpg,
  1076. TRANSPORT_TPG_TYPE_NORMAL);
  1077. if (ret < 0)
  1078. return ERR_PTR(-ENOMEM);
  1079. pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s"
  1080. " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
  1081. config_item_name(&wwn->wwn_group.cg_item), tpgt);
  1082. return &tl_tpg->tl_se_tpg;
  1083. }
  1084. void tcm_loop_drop_naa_tpg(
  1085. struct se_portal_group *se_tpg)
  1086. {
  1087. struct se_wwn *wwn = se_tpg->se_tpg_wwn;
  1088. struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
  1089. struct tcm_loop_tpg, tl_se_tpg);
  1090. struct tcm_loop_hba *tl_hba;
  1091. unsigned short tpgt;
  1092. tl_hba = tl_tpg->tl_hba;
  1093. tpgt = tl_tpg->tl_tpgt;
  1094. /*
  1095. * Release the I_T Nexus for the Virtual SAS link if present
  1096. */
  1097. tcm_loop_drop_nexus(tl_tpg);
  1098. /*
  1099. * Deregister the tl_tpg as a emulated SAS TCM Target Endpoint
  1100. */
  1101. core_tpg_deregister(se_tpg);
  1102. tl_tpg->tl_hba = NULL;
  1103. tl_tpg->tl_tpgt = 0;
  1104. pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s"
  1105. " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
  1106. config_item_name(&wwn->wwn_group.cg_item), tpgt);
  1107. }
  1108. /* End items for tcm_loop_naa_cit */
  1109. /* Start items for tcm_loop_cit */
  1110. struct se_wwn *tcm_loop_make_scsi_hba(
  1111. struct target_fabric_configfs *tf,
  1112. struct config_group *group,
  1113. const char *name)
  1114. {
  1115. struct tcm_loop_hba *tl_hba;
  1116. struct Scsi_Host *sh;
  1117. char *ptr;
  1118. int ret, off = 0;
  1119. tl_hba = kzalloc(sizeof(struct tcm_loop_hba), GFP_KERNEL);
  1120. if (!tl_hba) {
  1121. pr_err("Unable to allocate struct tcm_loop_hba\n");
  1122. return ERR_PTR(-ENOMEM);
  1123. }
  1124. /*
  1125. * Determine the emulated Protocol Identifier and Target Port Name
  1126. * based on the incoming configfs directory name.
  1127. */
  1128. ptr = strstr(name, "naa.");
  1129. if (ptr) {
  1130. tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS;
  1131. goto check_len;
  1132. }
  1133. ptr = strstr(name, "fc.");
  1134. if (ptr) {
  1135. tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP;
  1136. off = 3; /* Skip over "fc." */
  1137. goto check_len;
  1138. }
  1139. ptr = strstr(name, "iqn.");
  1140. if (!ptr) {
  1141. pr_err("Unable to locate prefix for emulated Target "
  1142. "Port: %s\n", name);
  1143. ret = -EINVAL;
  1144. goto out;
  1145. }
  1146. tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI;
  1147. check_len:
  1148. if (strlen(name) >= TL_WWN_ADDR_LEN) {
  1149. pr_err("Emulated NAA %s Address: %s, exceeds"
  1150. " max: %d\n", name, tcm_loop_dump_proto_id(tl_hba),
  1151. TL_WWN_ADDR_LEN);
  1152. ret = -EINVAL;
  1153. goto out;
  1154. }
  1155. snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]);
  1156. /*
  1157. * Call device_register(tl_hba->dev) to register the emulated
  1158. * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after
  1159. * device_register() callbacks in tcm_loop_driver_probe()
  1160. */
  1161. ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt);
  1162. if (ret)
  1163. goto out;
  1164. sh = tl_hba->sh;
  1165. tcm_loop_hba_no_cnt++;
  1166. pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target"
  1167. " %s Address: %s at Linux/SCSI Host ID: %d\n",
  1168. tcm_loop_dump_proto_id(tl_hba), name, sh->host_no);
  1169. return &tl_hba->tl_hba_wwn;
  1170. out:
  1171. kfree(tl_hba);
  1172. return ERR_PTR(ret);
  1173. }
  1174. void tcm_loop_drop_scsi_hba(
  1175. struct se_wwn *wwn)
  1176. {
  1177. struct tcm_loop_hba *tl_hba = container_of(wwn,
  1178. struct tcm_loop_hba, tl_hba_wwn);
  1179. pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target"
  1180. " SAS Address: %s at Linux/SCSI Host ID: %d\n",
  1181. tl_hba->tl_wwn_address, tl_hba->sh->host_no);
  1182. /*
  1183. * Call device_unregister() on the original tl_hba->dev.
  1184. * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will
  1185. * release *tl_hba;
  1186. */
  1187. device_unregister(&tl_hba->dev);
  1188. }
  1189. /* Start items for tcm_loop_cit */
  1190. static ssize_t tcm_loop_wwn_show_attr_version(
  1191. struct target_fabric_configfs *tf,
  1192. char *page)
  1193. {
  1194. return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION);
  1195. }
  1196. TF_WWN_ATTR_RO(tcm_loop, version);
  1197. static struct configfs_attribute *tcm_loop_wwn_attrs[] = {
  1198. &tcm_loop_wwn_version.attr,
  1199. NULL,
  1200. };
  1201. /* End items for tcm_loop_cit */
  1202. static int tcm_loop_register_configfs(void)
  1203. {
  1204. struct target_fabric_configfs *fabric;
  1205. struct config_group *tf_cg;
  1206. int ret;
  1207. /*
  1208. * Set the TCM Loop HBA counter to zero
  1209. */
  1210. tcm_loop_hba_no_cnt = 0;
  1211. /*
  1212. * Register the top level struct config_item_type with TCM core
  1213. */
  1214. fabric = target_fabric_configfs_init(THIS_MODULE, "loopback");
  1215. if (IS_ERR(fabric)) {
  1216. pr_err("tcm_loop_register_configfs() failed!\n");
  1217. return PTR_ERR(fabric);
  1218. }
  1219. /*
  1220. * Setup the fabric API of function pointers used by target_core_mod
  1221. */
  1222. fabric->tf_ops.get_fabric_name = &tcm_loop_get_fabric_name;
  1223. fabric->tf_ops.get_fabric_proto_ident = &tcm_loop_get_fabric_proto_ident;
  1224. fabric->tf_ops.tpg_get_wwn = &tcm_loop_get_endpoint_wwn;
  1225. fabric->tf_ops.tpg_get_tag = &tcm_loop_get_tag;
  1226. fabric->tf_ops.tpg_get_default_depth = &tcm_loop_get_default_depth;
  1227. fabric->tf_ops.tpg_get_pr_transport_id = &tcm_loop_get_pr_transport_id;
  1228. fabric->tf_ops.tpg_get_pr_transport_id_len =
  1229. &tcm_loop_get_pr_transport_id_len;
  1230. fabric->tf_ops.tpg_parse_pr_out_transport_id =
  1231. &tcm_loop_parse_pr_out_transport_id;
  1232. fabric->tf_ops.tpg_check_demo_mode = &tcm_loop_check_demo_mode;
  1233. fabric->tf_ops.tpg_check_demo_mode_cache =
  1234. &tcm_loop_check_demo_mode_cache;
  1235. fabric->tf_ops.tpg_check_demo_mode_write_protect =
  1236. &tcm_loop_check_demo_mode_write_protect;
  1237. fabric->tf_ops.tpg_check_prod_mode_write_protect =
  1238. &tcm_loop_check_prod_mode_write_protect;
  1239. /*
  1240. * The TCM loopback fabric module runs in demo-mode to a local
  1241. * virtual SCSI device, so fabric dependent initator ACLs are
  1242. * not required.
  1243. */
  1244. fabric->tf_ops.tpg_alloc_fabric_acl = &tcm_loop_tpg_alloc_fabric_acl;
  1245. fabric->tf_ops.tpg_release_fabric_acl =
  1246. &tcm_loop_tpg_release_fabric_acl;
  1247. fabric->tf_ops.tpg_get_inst_index = &tcm_loop_get_inst_index;
  1248. /*
  1249. * Used for setting up remaining TCM resources in process context
  1250. */
  1251. fabric->tf_ops.new_cmd_map = &tcm_loop_new_cmd_map;
  1252. fabric->tf_ops.check_stop_free = &tcm_loop_check_stop_free;
  1253. fabric->tf_ops.release_cmd = &tcm_loop_release_cmd;
  1254. fabric->tf_ops.shutdown_session = &tcm_loop_shutdown_session;
  1255. fabric->tf_ops.close_session = &tcm_loop_close_session;
  1256. fabric->tf_ops.stop_session = &tcm_loop_stop_session;
  1257. fabric->tf_ops.fall_back_to_erl0 = &tcm_loop_fall_back_to_erl0;
  1258. fabric->tf_ops.sess_logged_in = &tcm_loop_sess_logged_in;
  1259. fabric->tf_ops.sess_get_index = &tcm_loop_sess_get_index;
  1260. fabric->tf_ops.sess_get_initiator_sid = NULL;
  1261. fabric->tf_ops.write_pending = &tcm_loop_write_pending;
  1262. fabric->tf_ops.write_pending_status = &tcm_loop_write_pending_status;
  1263. /*
  1264. * Not used for TCM loopback
  1265. */
  1266. fabric->tf_ops.set_default_node_attributes =
  1267. &tcm_loop_set_default_node_attributes;
  1268. fabric->tf_ops.get_task_tag = &tcm_loop_get_task_tag;
  1269. fabric->tf_ops.get_cmd_state = &tcm_loop_get_cmd_state;
  1270. fabric->tf_ops.queue_data_in = &tcm_loop_queue_data_in;
  1271. fabric->tf_ops.queue_status = &tcm_loop_queue_status;
  1272. fabric->tf_ops.queue_tm_rsp = &tcm_loop_queue_tm_rsp;
  1273. fabric->tf_ops.set_fabric_sense_len = &tcm_loop_set_fabric_sense_len;
  1274. fabric->tf_ops.get_fabric_sense_len = &tcm_loop_get_fabric_sense_len;
  1275. fabric->tf_ops.is_state_remove = &tcm_loop_is_state_remove;
  1276. tf_cg = &fabric->tf_group;
  1277. /*
  1278. * Setup function pointers for generic logic in target_core_fabric_configfs.c
  1279. */
  1280. fabric->tf_ops.fabric_make_wwn = &tcm_loop_make_scsi_hba;
  1281. fabric->tf_ops.fabric_drop_wwn = &tcm_loop_drop_scsi_hba;
  1282. fabric->tf_ops.fabric_make_tpg = &tcm_loop_make_naa_tpg;
  1283. fabric->tf_ops.fabric_drop_tpg = &tcm_loop_drop_naa_tpg;
  1284. /*
  1285. * fabric_post_link() and fabric_pre_unlink() are used for
  1286. * registration and release of TCM Loop Virtual SCSI LUNs.
  1287. */
  1288. fabric->tf_ops.fabric_post_link = &tcm_loop_port_link;
  1289. fabric->tf_ops.fabric_pre_unlink = &tcm_loop_port_unlink;
  1290. fabric->tf_ops.fabric_make_np = NULL;
  1291. fabric->tf_ops.fabric_drop_np = NULL;
  1292. /*
  1293. * Setup default attribute lists for various fabric->tf_cit_tmpl
  1294. */
  1295. TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = tcm_loop_wwn_attrs;
  1296. TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = tcm_loop_tpg_attrs;
  1297. TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
  1298. TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
  1299. TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
  1300. /*
  1301. * Once fabric->tf_ops has been setup, now register the fabric for
  1302. * use within TCM
  1303. */
  1304. ret = target_fabric_configfs_register(fabric);
  1305. if (ret < 0) {
  1306. pr_err("target_fabric_configfs_register() for"
  1307. " TCM_Loop failed!\n");
  1308. target_fabric_configfs_free(fabric);
  1309. return -1;
  1310. }
  1311. /*
  1312. * Setup our local pointer to *fabric.
  1313. */
  1314. tcm_loop_fabric_configfs = fabric;
  1315. pr_debug("TCM_LOOP[0] - Set fabric ->"
  1316. " tcm_loop_fabric_configfs\n");
  1317. return 0;
  1318. }
  1319. static void tcm_loop_deregister_configfs(void)
  1320. {
  1321. if (!tcm_loop_fabric_configfs)
  1322. return;
  1323. target_fabric_configfs_deregister(tcm_loop_fabric_configfs);
  1324. tcm_loop_fabric_configfs = NULL;
  1325. pr_debug("TCM_LOOP[0] - Cleared"
  1326. " tcm_loop_fabric_configfs\n");
  1327. }
  1328. static int __init tcm_loop_fabric_init(void)
  1329. {
  1330. int ret;
  1331. tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache",
  1332. sizeof(struct tcm_loop_cmd),
  1333. __alignof__(struct tcm_loop_cmd),
  1334. 0, NULL);
  1335. if (!tcm_loop_cmd_cache) {
  1336. pr_debug("kmem_cache_create() for"
  1337. " tcm_loop_cmd_cache failed\n");
  1338. return -ENOMEM;
  1339. }
  1340. ret = tcm_loop_alloc_core_bus();
  1341. if (ret)
  1342. return ret;
  1343. ret = tcm_loop_register_configfs();
  1344. if (ret) {
  1345. tcm_loop_release_core_bus();
  1346. return ret;
  1347. }
  1348. return 0;
  1349. }
  1350. static void __exit tcm_loop_fabric_exit(void)
  1351. {
  1352. tcm_loop_deregister_configfs();
  1353. tcm_loop_release_core_bus();
  1354. kmem_cache_destroy(tcm_loop_cmd_cache);
  1355. }
  1356. MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module");
  1357. MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>");
  1358. MODULE_LICENSE("GPL");
  1359. module_init(tcm_loop_fabric_init);
  1360. module_exit(tcm_loop_fabric_exit);