tcm_loop.c 41 KB

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