tcm_loop.c 40 KB

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