tcm_loop.c 39 KB

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