target_core_pscsi.c 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146
  1. /*******************************************************************************
  2. * Filename: target_core_pscsi.c
  3. *
  4. * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
  5. *
  6. * (c) Copyright 2003-2013 Datera, Inc.
  7. *
  8. * Nicholas A. Bellinger <nab@kernel.org>
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of the GNU General Public License as published by
  12. * the Free Software Foundation; either version 2 of the License, or
  13. * (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU General Public License
  21. * along with this program; if not, write to the Free Software
  22. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23. *
  24. ******************************************************************************/
  25. #include <linux/string.h>
  26. #include <linux/parser.h>
  27. #include <linux/timer.h>
  28. #include <linux/blkdev.h>
  29. #include <linux/blk_types.h>
  30. #include <linux/slab.h>
  31. #include <linux/spinlock.h>
  32. #include <linux/genhd.h>
  33. #include <linux/cdrom.h>
  34. #include <linux/ratelimit.h>
  35. #include <linux/module.h>
  36. #include <asm/unaligned.h>
  37. #include <scsi/scsi_device.h>
  38. #include <scsi/scsi_host.h>
  39. #include <scsi/scsi_tcq.h>
  40. #include <target/target_core_base.h>
  41. #include <target/target_core_backend.h>
  42. #include "target_core_alua.h"
  43. #include "target_core_internal.h"
  44. #include "target_core_pscsi.h"
  45. #define ISPRINT(a) ((a >= ' ') && (a <= '~'))
  46. static inline struct pscsi_dev_virt *PSCSI_DEV(struct se_device *dev)
  47. {
  48. return container_of(dev, struct pscsi_dev_virt, dev);
  49. }
  50. static sense_reason_t pscsi_execute_cmd(struct se_cmd *cmd);
  51. static void pscsi_req_done(struct request *, blk_status_t);
  52. /* pscsi_attach_hba():
  53. *
  54. * pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
  55. * from the passed SCSI Host ID.
  56. */
  57. static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
  58. {
  59. struct pscsi_hba_virt *phv;
  60. phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
  61. if (!phv) {
  62. pr_err("Unable to allocate struct pscsi_hba_virt\n");
  63. return -ENOMEM;
  64. }
  65. phv->phv_host_id = host_id;
  66. phv->phv_mode = PHV_VIRTUAL_HOST_ID;
  67. hba->hba_ptr = phv;
  68. pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
  69. " Generic Target Core Stack %s\n", hba->hba_id,
  70. PSCSI_VERSION, TARGET_CORE_VERSION);
  71. pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
  72. hba->hba_id);
  73. return 0;
  74. }
  75. static void pscsi_detach_hba(struct se_hba *hba)
  76. {
  77. struct pscsi_hba_virt *phv = hba->hba_ptr;
  78. struct Scsi_Host *scsi_host = phv->phv_lld_host;
  79. if (scsi_host) {
  80. scsi_host_put(scsi_host);
  81. pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
  82. " Generic Target Core\n", hba->hba_id,
  83. (scsi_host->hostt->name) ? (scsi_host->hostt->name) :
  84. "Unknown");
  85. } else
  86. pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
  87. " from Generic Target Core\n", hba->hba_id);
  88. kfree(phv);
  89. hba->hba_ptr = NULL;
  90. }
  91. static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
  92. {
  93. struct pscsi_hba_virt *phv = hba->hba_ptr;
  94. struct Scsi_Host *sh = phv->phv_lld_host;
  95. /*
  96. * Release the struct Scsi_Host
  97. */
  98. if (!mode_flag) {
  99. if (!sh)
  100. return 0;
  101. phv->phv_lld_host = NULL;
  102. phv->phv_mode = PHV_VIRTUAL_HOST_ID;
  103. pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
  104. " %s\n", hba->hba_id, (sh->hostt->name) ?
  105. (sh->hostt->name) : "Unknown");
  106. scsi_host_put(sh);
  107. return 0;
  108. }
  109. /*
  110. * Otherwise, locate struct Scsi_Host from the original passed
  111. * pSCSI Host ID and enable for phba mode
  112. */
  113. sh = scsi_host_lookup(phv->phv_host_id);
  114. if (!sh) {
  115. pr_err("pSCSI: Unable to locate SCSI Host for"
  116. " phv_host_id: %d\n", phv->phv_host_id);
  117. return -EINVAL;
  118. }
  119. phv->phv_lld_host = sh;
  120. phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
  121. pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
  122. hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
  123. return 1;
  124. }
  125. static void pscsi_tape_read_blocksize(struct se_device *dev,
  126. struct scsi_device *sdev)
  127. {
  128. unsigned char cdb[MAX_COMMAND_SIZE], *buf;
  129. int ret;
  130. buf = kzalloc(12, GFP_KERNEL);
  131. if (!buf)
  132. goto out_free;
  133. memset(cdb, 0, MAX_COMMAND_SIZE);
  134. cdb[0] = MODE_SENSE;
  135. cdb[4] = 0x0c; /* 12 bytes */
  136. ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
  137. HZ, 1, NULL);
  138. if (ret)
  139. goto out_free;
  140. /*
  141. * If MODE_SENSE still returns zero, set the default value to 1024.
  142. */
  143. sdev->sector_size = get_unaligned_be24(&buf[9]);
  144. out_free:
  145. if (!sdev->sector_size)
  146. sdev->sector_size = 1024;
  147. kfree(buf);
  148. }
  149. static void
  150. pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
  151. {
  152. unsigned char *buf;
  153. if (sdev->inquiry_len < INQUIRY_LEN)
  154. return;
  155. buf = sdev->inquiry;
  156. if (!buf)
  157. return;
  158. /*
  159. * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
  160. */
  161. memcpy(&wwn->vendor[0], &buf[8], sizeof(wwn->vendor));
  162. memcpy(&wwn->model[0], &buf[16], sizeof(wwn->model));
  163. memcpy(&wwn->revision[0], &buf[32], sizeof(wwn->revision));
  164. }
  165. static int
  166. pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
  167. {
  168. unsigned char cdb[MAX_COMMAND_SIZE], *buf;
  169. int ret;
  170. buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
  171. if (!buf)
  172. return -ENOMEM;
  173. memset(cdb, 0, MAX_COMMAND_SIZE);
  174. cdb[0] = INQUIRY;
  175. cdb[1] = 0x01; /* Query VPD */
  176. cdb[2] = 0x80; /* Unit Serial Number */
  177. put_unaligned_be16(INQUIRY_VPD_SERIAL_LEN, &cdb[3]);
  178. ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
  179. INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
  180. if (ret)
  181. goto out_free;
  182. snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
  183. wwn->t10_dev->dev_flags |= DF_FIRMWARE_VPD_UNIT_SERIAL;
  184. kfree(buf);
  185. return 0;
  186. out_free:
  187. kfree(buf);
  188. return -EPERM;
  189. }
  190. static void
  191. pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
  192. struct t10_wwn *wwn)
  193. {
  194. unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
  195. int ident_len, page_len, off = 4, ret;
  196. struct t10_vpd *vpd;
  197. buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
  198. if (!buf)
  199. return;
  200. memset(cdb, 0, MAX_COMMAND_SIZE);
  201. cdb[0] = INQUIRY;
  202. cdb[1] = 0x01; /* Query VPD */
  203. cdb[2] = 0x83; /* Device Identifier */
  204. put_unaligned_be16(INQUIRY_VPD_DEVICE_IDENTIFIER_LEN, &cdb[3]);
  205. ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
  206. INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
  207. NULL, HZ, 1, NULL);
  208. if (ret)
  209. goto out;
  210. page_len = get_unaligned_be16(&buf[2]);
  211. while (page_len > 0) {
  212. /* Grab a pointer to the Identification descriptor */
  213. page_83 = &buf[off];
  214. ident_len = page_83[3];
  215. if (!ident_len) {
  216. pr_err("page_83[3]: identifier"
  217. " length zero!\n");
  218. break;
  219. }
  220. pr_debug("T10 VPD Identifier Length: %d\n", ident_len);
  221. vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
  222. if (!vpd) {
  223. pr_err("Unable to allocate memory for"
  224. " struct t10_vpd\n");
  225. goto out;
  226. }
  227. INIT_LIST_HEAD(&vpd->vpd_list);
  228. transport_set_vpd_proto_id(vpd, page_83);
  229. transport_set_vpd_assoc(vpd, page_83);
  230. if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
  231. off += (ident_len + 4);
  232. page_len -= (ident_len + 4);
  233. kfree(vpd);
  234. continue;
  235. }
  236. if (transport_set_vpd_ident(vpd, page_83) < 0) {
  237. off += (ident_len + 4);
  238. page_len -= (ident_len + 4);
  239. kfree(vpd);
  240. continue;
  241. }
  242. list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
  243. off += (ident_len + 4);
  244. page_len -= (ident_len + 4);
  245. }
  246. out:
  247. kfree(buf);
  248. }
  249. static int pscsi_add_device_to_list(struct se_device *dev,
  250. struct scsi_device *sd)
  251. {
  252. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  253. struct request_queue *q = sd->request_queue;
  254. pdv->pdv_sd = sd;
  255. if (!sd->queue_depth) {
  256. sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
  257. pr_err("Set broken SCSI Device %d:%d:%llu"
  258. " queue_depth to %d\n", sd->channel, sd->id,
  259. sd->lun, sd->queue_depth);
  260. }
  261. dev->dev_attrib.hw_block_size =
  262. min_not_zero((int)sd->sector_size, 512);
  263. dev->dev_attrib.hw_max_sectors =
  264. min_not_zero(sd->host->max_sectors, queue_max_hw_sectors(q));
  265. dev->dev_attrib.hw_queue_depth = sd->queue_depth;
  266. /*
  267. * Setup our standard INQUIRY info into se_dev->t10_wwn
  268. */
  269. pscsi_set_inquiry_info(sd, &dev->t10_wwn);
  270. /*
  271. * Locate VPD WWN Information used for various purposes within
  272. * the Storage Engine.
  273. */
  274. if (!pscsi_get_inquiry_vpd_serial(sd, &dev->t10_wwn)) {
  275. /*
  276. * If VPD Unit Serial returned GOOD status, try
  277. * VPD Device Identification page (0x83).
  278. */
  279. pscsi_get_inquiry_vpd_device_ident(sd, &dev->t10_wwn);
  280. }
  281. /*
  282. * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
  283. */
  284. if (sd->type == TYPE_TAPE) {
  285. pscsi_tape_read_blocksize(dev, sd);
  286. dev->dev_attrib.hw_block_size = sd->sector_size;
  287. }
  288. return 0;
  289. }
  290. static struct se_device *pscsi_alloc_device(struct se_hba *hba,
  291. const char *name)
  292. {
  293. struct pscsi_dev_virt *pdv;
  294. pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
  295. if (!pdv) {
  296. pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
  297. return NULL;
  298. }
  299. pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
  300. return &pdv->dev;
  301. }
  302. /*
  303. * Called with struct Scsi_Host->host_lock called.
  304. */
  305. static int pscsi_create_type_disk(struct se_device *dev, struct scsi_device *sd)
  306. __releases(sh->host_lock)
  307. {
  308. struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
  309. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  310. struct Scsi_Host *sh = sd->host;
  311. struct block_device *bd;
  312. int ret;
  313. if (scsi_device_get(sd)) {
  314. pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
  315. sh->host_no, sd->channel, sd->id, sd->lun);
  316. spin_unlock_irq(sh->host_lock);
  317. return -EIO;
  318. }
  319. spin_unlock_irq(sh->host_lock);
  320. /*
  321. * Claim exclusive struct block_device access to struct scsi_device
  322. * for TYPE_DISK and TYPE_ZBC using supplied udev_path
  323. */
  324. bd = blkdev_get_by_path(dev->udev_path,
  325. FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
  326. if (IS_ERR(bd)) {
  327. pr_err("pSCSI: blkdev_get_by_path() failed\n");
  328. scsi_device_put(sd);
  329. return PTR_ERR(bd);
  330. }
  331. pdv->pdv_bd = bd;
  332. ret = pscsi_add_device_to_list(dev, sd);
  333. if (ret) {
  334. blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
  335. scsi_device_put(sd);
  336. return ret;
  337. }
  338. pr_debug("CORE_PSCSI[%d] - Added TYPE_%s for %d:%d:%d:%llu\n",
  339. phv->phv_host_id, sd->type == TYPE_DISK ? "DISK" : "ZBC",
  340. sh->host_no, sd->channel, sd->id, sd->lun);
  341. return 0;
  342. }
  343. /*
  344. * Called with struct Scsi_Host->host_lock called.
  345. */
  346. static int pscsi_create_type_nondisk(struct se_device *dev, struct scsi_device *sd)
  347. __releases(sh->host_lock)
  348. {
  349. struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
  350. struct Scsi_Host *sh = sd->host;
  351. int ret;
  352. if (scsi_device_get(sd)) {
  353. pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
  354. sh->host_no, sd->channel, sd->id, sd->lun);
  355. spin_unlock_irq(sh->host_lock);
  356. return -EIO;
  357. }
  358. spin_unlock_irq(sh->host_lock);
  359. ret = pscsi_add_device_to_list(dev, sd);
  360. if (ret) {
  361. scsi_device_put(sd);
  362. return ret;
  363. }
  364. pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%llu\n",
  365. phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
  366. sd->channel, sd->id, sd->lun);
  367. return 0;
  368. }
  369. static int pscsi_configure_device(struct se_device *dev)
  370. {
  371. struct se_hba *hba = dev->se_hba;
  372. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  373. struct scsi_device *sd;
  374. struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
  375. struct Scsi_Host *sh = phv->phv_lld_host;
  376. int legacy_mode_enable = 0;
  377. int ret;
  378. if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
  379. !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
  380. !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
  381. pr_err("Missing scsi_channel_id=, scsi_target_id= and"
  382. " scsi_lun_id= parameters\n");
  383. return -EINVAL;
  384. }
  385. /*
  386. * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
  387. * struct Scsi_Host we will need to bring the TCM/pSCSI object online
  388. */
  389. if (!sh) {
  390. if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
  391. pr_err("pSCSI: Unable to locate struct"
  392. " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
  393. return -ENODEV;
  394. }
  395. /*
  396. * For the newer PHV_VIRTUAL_HOST_ID struct scsi_device
  397. * reference, we enforce that udev_path has been set
  398. */
  399. if (!(dev->dev_flags & DF_USING_UDEV_PATH)) {
  400. pr_err("pSCSI: udev_path attribute has not"
  401. " been set before ENABLE=1\n");
  402. return -EINVAL;
  403. }
  404. /*
  405. * If no scsi_host_id= was passed for PHV_VIRTUAL_HOST_ID,
  406. * use the original TCM hba ID to reference Linux/SCSI Host No
  407. * and enable for PHV_LLD_SCSI_HOST_NO mode.
  408. */
  409. if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
  410. if (hba->dev_count) {
  411. pr_err("pSCSI: Unable to set hba_mode"
  412. " with active devices\n");
  413. return -EEXIST;
  414. }
  415. if (pscsi_pmode_enable_hba(hba, 1) != 1)
  416. return -ENODEV;
  417. legacy_mode_enable = 1;
  418. hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
  419. sh = phv->phv_lld_host;
  420. } else {
  421. sh = scsi_host_lookup(pdv->pdv_host_id);
  422. if (!sh) {
  423. pr_err("pSCSI: Unable to locate"
  424. " pdv_host_id: %d\n", pdv->pdv_host_id);
  425. return -EINVAL;
  426. }
  427. pdv->pdv_lld_host = sh;
  428. }
  429. } else {
  430. if (phv->phv_mode == PHV_VIRTUAL_HOST_ID) {
  431. pr_err("pSCSI: PHV_VIRTUAL_HOST_ID set while"
  432. " struct Scsi_Host exists\n");
  433. return -EEXIST;
  434. }
  435. }
  436. spin_lock_irq(sh->host_lock);
  437. list_for_each_entry(sd, &sh->__devices, siblings) {
  438. if ((pdv->pdv_channel_id != sd->channel) ||
  439. (pdv->pdv_target_id != sd->id) ||
  440. (pdv->pdv_lun_id != sd->lun))
  441. continue;
  442. /*
  443. * Functions will release the held struct scsi_host->host_lock
  444. * before calling calling pscsi_add_device_to_list() to register
  445. * struct scsi_device with target_core_mod.
  446. */
  447. switch (sd->type) {
  448. case TYPE_DISK:
  449. case TYPE_ZBC:
  450. ret = pscsi_create_type_disk(dev, sd);
  451. break;
  452. default:
  453. ret = pscsi_create_type_nondisk(dev, sd);
  454. break;
  455. }
  456. if (ret) {
  457. if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
  458. scsi_host_put(sh);
  459. else if (legacy_mode_enable) {
  460. pscsi_pmode_enable_hba(hba, 0);
  461. hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
  462. }
  463. pdv->pdv_sd = NULL;
  464. return ret;
  465. }
  466. return 0;
  467. }
  468. spin_unlock_irq(sh->host_lock);
  469. pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
  470. pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id);
  471. if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
  472. scsi_host_put(sh);
  473. else if (legacy_mode_enable) {
  474. pscsi_pmode_enable_hba(hba, 0);
  475. hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
  476. }
  477. return -ENODEV;
  478. }
  479. static void pscsi_dev_call_rcu(struct rcu_head *p)
  480. {
  481. struct se_device *dev = container_of(p, struct se_device, rcu_head);
  482. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  483. kfree(pdv);
  484. }
  485. static void pscsi_free_device(struct se_device *dev)
  486. {
  487. call_rcu(&dev->rcu_head, pscsi_dev_call_rcu);
  488. }
  489. static void pscsi_destroy_device(struct se_device *dev)
  490. {
  491. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  492. struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
  493. struct scsi_device *sd = pdv->pdv_sd;
  494. if (sd) {
  495. /*
  496. * Release exclusive pSCSI internal struct block_device claim for
  497. * struct scsi_device with TYPE_DISK or TYPE_ZBC
  498. * from pscsi_create_type_disk()
  499. */
  500. if ((sd->type == TYPE_DISK || sd->type == TYPE_ZBC) &&
  501. pdv->pdv_bd) {
  502. blkdev_put(pdv->pdv_bd,
  503. FMODE_WRITE|FMODE_READ|FMODE_EXCL);
  504. pdv->pdv_bd = NULL;
  505. }
  506. /*
  507. * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
  508. * to struct Scsi_Host now.
  509. */
  510. if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
  511. (phv->phv_lld_host != NULL))
  512. scsi_host_put(phv->phv_lld_host);
  513. else if (pdv->pdv_lld_host)
  514. scsi_host_put(pdv->pdv_lld_host);
  515. scsi_device_put(sd);
  516. pdv->pdv_sd = NULL;
  517. }
  518. }
  519. static void pscsi_complete_cmd(struct se_cmd *cmd, u8 scsi_status,
  520. unsigned char *req_sense)
  521. {
  522. struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
  523. struct scsi_device *sd = pdv->pdv_sd;
  524. struct pscsi_plugin_task *pt = cmd->priv;
  525. unsigned char *cdb;
  526. /*
  527. * Special case for REPORT_LUNs handling where pscsi_plugin_task has
  528. * not been allocated because TCM is handling the emulation directly.
  529. */
  530. if (!pt)
  531. return;
  532. cdb = &pt->pscsi_cdb[0];
  533. /*
  534. * Hack to make sure that Write-Protect modepage is set if R/O mode is
  535. * forced.
  536. */
  537. if (!cmd->data_length)
  538. goto after_mode_sense;
  539. if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
  540. scsi_status == SAM_STAT_GOOD) {
  541. bool read_only = target_lun_is_rdonly(cmd);
  542. if (read_only) {
  543. unsigned char *buf;
  544. buf = transport_kmap_data_sg(cmd);
  545. if (!buf) {
  546. ; /* XXX: TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE */
  547. }
  548. if (cdb[0] == MODE_SENSE_10) {
  549. if (!(buf[3] & 0x80))
  550. buf[3] |= 0x80;
  551. } else {
  552. if (!(buf[2] & 0x80))
  553. buf[2] |= 0x80;
  554. }
  555. transport_kunmap_data_sg(cmd);
  556. }
  557. }
  558. after_mode_sense:
  559. if (sd->type != TYPE_TAPE || !cmd->data_length)
  560. goto after_mode_select;
  561. /*
  562. * Hack to correctly obtain the initiator requested blocksize for
  563. * TYPE_TAPE. Since this value is dependent upon each tape media,
  564. * struct scsi_device->sector_size will not contain the correct value
  565. * by default, so we go ahead and set it so
  566. * TRANSPORT(dev)->get_blockdev() returns the correct value to the
  567. * storage engine.
  568. */
  569. if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
  570. scsi_status == SAM_STAT_GOOD) {
  571. unsigned char *buf;
  572. u16 bdl;
  573. u32 blocksize;
  574. buf = sg_virt(&cmd->t_data_sg[0]);
  575. if (!buf) {
  576. pr_err("Unable to get buf for scatterlist\n");
  577. goto after_mode_select;
  578. }
  579. if (cdb[0] == MODE_SELECT)
  580. bdl = buf[3];
  581. else
  582. bdl = get_unaligned_be16(&buf[6]);
  583. if (!bdl)
  584. goto after_mode_select;
  585. if (cdb[0] == MODE_SELECT)
  586. blocksize = get_unaligned_be24(&buf[9]);
  587. else
  588. blocksize = get_unaligned_be24(&buf[13]);
  589. sd->sector_size = blocksize;
  590. }
  591. after_mode_select:
  592. if (scsi_status == SAM_STAT_CHECK_CONDITION) {
  593. transport_copy_sense_to_cmd(cmd, req_sense);
  594. /*
  595. * check for TAPE device reads with
  596. * FM/EOM/ILI set, so that we can get data
  597. * back despite framework assumption that a
  598. * check condition means there is no data
  599. */
  600. if (sd->type == TYPE_TAPE &&
  601. cmd->data_direction == DMA_FROM_DEVICE) {
  602. /*
  603. * is sense data valid, fixed format,
  604. * and have FM, EOM, or ILI set?
  605. */
  606. if (req_sense[0] == 0xf0 && /* valid, fixed format */
  607. req_sense[2] & 0xe0 && /* FM, EOM, or ILI */
  608. (req_sense[2] & 0xf) == 0) { /* key==NO_SENSE */
  609. pr_debug("Tape FM/EOM/ILI status detected. Treat as normal read.\n");
  610. cmd->se_cmd_flags |= SCF_TREAT_READ_AS_NORMAL;
  611. }
  612. }
  613. }
  614. }
  615. enum {
  616. Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
  617. Opt_scsi_lun_id, Opt_err
  618. };
  619. static match_table_t tokens = {
  620. {Opt_scsi_host_id, "scsi_host_id=%d"},
  621. {Opt_scsi_channel_id, "scsi_channel_id=%d"},
  622. {Opt_scsi_target_id, "scsi_target_id=%d"},
  623. {Opt_scsi_lun_id, "scsi_lun_id=%d"},
  624. {Opt_err, NULL}
  625. };
  626. static ssize_t pscsi_set_configfs_dev_params(struct se_device *dev,
  627. const char *page, ssize_t count)
  628. {
  629. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  630. struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
  631. char *orig, *ptr, *opts;
  632. substring_t args[MAX_OPT_ARGS];
  633. int ret = 0, arg, token;
  634. opts = kstrdup(page, GFP_KERNEL);
  635. if (!opts)
  636. return -ENOMEM;
  637. orig = opts;
  638. while ((ptr = strsep(&opts, ",\n")) != NULL) {
  639. if (!*ptr)
  640. continue;
  641. token = match_token(ptr, tokens, args);
  642. switch (token) {
  643. case Opt_scsi_host_id:
  644. if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
  645. pr_err("PSCSI[%d]: Unable to accept"
  646. " scsi_host_id while phv_mode =="
  647. " PHV_LLD_SCSI_HOST_NO\n",
  648. phv->phv_host_id);
  649. ret = -EINVAL;
  650. goto out;
  651. }
  652. ret = match_int(args, &arg);
  653. if (ret)
  654. goto out;
  655. pdv->pdv_host_id = arg;
  656. pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
  657. " %d\n", phv->phv_host_id, pdv->pdv_host_id);
  658. pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
  659. break;
  660. case Opt_scsi_channel_id:
  661. ret = match_int(args, &arg);
  662. if (ret)
  663. goto out;
  664. pdv->pdv_channel_id = arg;
  665. pr_debug("PSCSI[%d]: Referencing SCSI Channel"
  666. " ID: %d\n", phv->phv_host_id,
  667. pdv->pdv_channel_id);
  668. pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
  669. break;
  670. case Opt_scsi_target_id:
  671. ret = match_int(args, &arg);
  672. if (ret)
  673. goto out;
  674. pdv->pdv_target_id = arg;
  675. pr_debug("PSCSI[%d]: Referencing SCSI Target"
  676. " ID: %d\n", phv->phv_host_id,
  677. pdv->pdv_target_id);
  678. pdv->pdv_flags |= PDF_HAS_TARGET_ID;
  679. break;
  680. case Opt_scsi_lun_id:
  681. ret = match_int(args, &arg);
  682. if (ret)
  683. goto out;
  684. pdv->pdv_lun_id = arg;
  685. pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
  686. " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
  687. pdv->pdv_flags |= PDF_HAS_LUN_ID;
  688. break;
  689. default:
  690. break;
  691. }
  692. }
  693. out:
  694. kfree(orig);
  695. return (!ret) ? count : ret;
  696. }
  697. static ssize_t pscsi_show_configfs_dev_params(struct se_device *dev, char *b)
  698. {
  699. struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
  700. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  701. struct scsi_device *sd = pdv->pdv_sd;
  702. unsigned char host_id[16];
  703. ssize_t bl;
  704. int i;
  705. if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
  706. snprintf(host_id, 16, "%d", pdv->pdv_host_id);
  707. else
  708. snprintf(host_id, 16, "PHBA Mode");
  709. bl = sprintf(b, "SCSI Device Bus Location:"
  710. " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
  711. pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
  712. host_id);
  713. if (sd) {
  714. bl += sprintf(b + bl, " ");
  715. bl += sprintf(b + bl, "Vendor: ");
  716. for (i = 0; i < 8; i++) {
  717. if (ISPRINT(sd->vendor[i])) /* printable character? */
  718. bl += sprintf(b + bl, "%c", sd->vendor[i]);
  719. else
  720. bl += sprintf(b + bl, " ");
  721. }
  722. bl += sprintf(b + bl, " Model: ");
  723. for (i = 0; i < 16; i++) {
  724. if (ISPRINT(sd->model[i])) /* printable character ? */
  725. bl += sprintf(b + bl, "%c", sd->model[i]);
  726. else
  727. bl += sprintf(b + bl, " ");
  728. }
  729. bl += sprintf(b + bl, " Rev: ");
  730. for (i = 0; i < 4; i++) {
  731. if (ISPRINT(sd->rev[i])) /* printable character ? */
  732. bl += sprintf(b + bl, "%c", sd->rev[i]);
  733. else
  734. bl += sprintf(b + bl, " ");
  735. }
  736. bl += sprintf(b + bl, "\n");
  737. }
  738. return bl;
  739. }
  740. static void pscsi_bi_endio(struct bio *bio)
  741. {
  742. bio_put(bio);
  743. }
  744. static inline struct bio *pscsi_get_bio(int nr_vecs)
  745. {
  746. struct bio *bio;
  747. /*
  748. * Use bio_malloc() following the comment in for bio -> struct request
  749. * in block/blk-core.c:blk_make_request()
  750. */
  751. bio = bio_kmalloc(GFP_KERNEL, nr_vecs);
  752. if (!bio) {
  753. pr_err("PSCSI: bio_kmalloc() failed\n");
  754. return NULL;
  755. }
  756. bio->bi_end_io = pscsi_bi_endio;
  757. return bio;
  758. }
  759. static sense_reason_t
  760. pscsi_map_sg(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
  761. struct request *req)
  762. {
  763. struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
  764. struct bio *bio = NULL;
  765. struct page *page;
  766. struct scatterlist *sg;
  767. u32 data_len = cmd->data_length, i, len, bytes, off;
  768. int nr_pages = (cmd->data_length + sgl[0].offset +
  769. PAGE_SIZE - 1) >> PAGE_SHIFT;
  770. int nr_vecs = 0, rc;
  771. int rw = (cmd->data_direction == DMA_TO_DEVICE);
  772. BUG_ON(!cmd->data_length);
  773. pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
  774. for_each_sg(sgl, sg, sgl_nents, i) {
  775. page = sg_page(sg);
  776. off = sg->offset;
  777. len = sg->length;
  778. pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
  779. page, len, off);
  780. /*
  781. * We only have one page of data in each sg element,
  782. * we can not cross a page boundary.
  783. */
  784. if (off + len > PAGE_SIZE)
  785. goto fail;
  786. if (len > 0 && data_len > 0) {
  787. bytes = min_t(unsigned int, len, PAGE_SIZE - off);
  788. bytes = min(bytes, data_len);
  789. if (!bio) {
  790. new_bio:
  791. nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
  792. nr_pages -= nr_vecs;
  793. /*
  794. * Calls bio_kmalloc() and sets bio->bi_end_io()
  795. */
  796. bio = pscsi_get_bio(nr_vecs);
  797. if (!bio)
  798. goto fail;
  799. if (rw)
  800. bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
  801. pr_debug("PSCSI: Allocated bio: %p,"
  802. " dir: %s nr_vecs: %d\n", bio,
  803. (rw) ? "rw" : "r", nr_vecs);
  804. }
  805. pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
  806. " bio: %p page: %p len: %d off: %d\n", i, bio,
  807. page, len, off);
  808. rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
  809. bio, page, bytes, off);
  810. pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
  811. bio_segments(bio), nr_vecs);
  812. if (rc != bytes) {
  813. pr_debug("PSCSI: Reached bio->bi_vcnt max:"
  814. " %d i: %d bio: %p, allocating another"
  815. " bio\n", bio->bi_vcnt, i, bio);
  816. rc = blk_rq_append_bio(req, &bio);
  817. if (rc) {
  818. pr_err("pSCSI: failed to append bio\n");
  819. goto fail;
  820. }
  821. /*
  822. * Clear the pointer so that another bio will
  823. * be allocated with pscsi_get_bio() above.
  824. */
  825. bio = NULL;
  826. goto new_bio;
  827. }
  828. data_len -= bytes;
  829. }
  830. }
  831. if (bio) {
  832. rc = blk_rq_append_bio(req, &bio);
  833. if (rc) {
  834. pr_err("pSCSI: failed to append bio\n");
  835. goto fail;
  836. }
  837. }
  838. return 0;
  839. fail:
  840. if (bio)
  841. bio_put(bio);
  842. while (req->bio) {
  843. bio = req->bio;
  844. req->bio = bio->bi_next;
  845. bio_put(bio);
  846. }
  847. req->biotail = NULL;
  848. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  849. }
  850. static sense_reason_t
  851. pscsi_parse_cdb(struct se_cmd *cmd)
  852. {
  853. if (cmd->se_cmd_flags & SCF_BIDI)
  854. return TCM_UNSUPPORTED_SCSI_OPCODE;
  855. return passthrough_parse_cdb(cmd, pscsi_execute_cmd);
  856. }
  857. static sense_reason_t
  858. pscsi_execute_cmd(struct se_cmd *cmd)
  859. {
  860. struct scatterlist *sgl = cmd->t_data_sg;
  861. u32 sgl_nents = cmd->t_data_nents;
  862. struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
  863. struct pscsi_plugin_task *pt;
  864. struct request *req;
  865. sense_reason_t ret;
  866. /*
  867. * Dynamically alloc cdb space, since it may be larger than
  868. * TCM_MAX_COMMAND_SIZE
  869. */
  870. pt = kzalloc(sizeof(*pt) + scsi_command_size(cmd->t_task_cdb), GFP_KERNEL);
  871. if (!pt) {
  872. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  873. }
  874. cmd->priv = pt;
  875. memcpy(pt->pscsi_cdb, cmd->t_task_cdb,
  876. scsi_command_size(cmd->t_task_cdb));
  877. req = blk_get_request(pdv->pdv_sd->request_queue,
  878. cmd->data_direction == DMA_TO_DEVICE ?
  879. REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
  880. if (IS_ERR(req)) {
  881. pr_err("PSCSI: blk_get_request() failed\n");
  882. ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  883. goto fail;
  884. }
  885. if (sgl) {
  886. ret = pscsi_map_sg(cmd, sgl, sgl_nents, req);
  887. if (ret)
  888. goto fail_put_request;
  889. }
  890. req->end_io = pscsi_req_done;
  891. req->end_io_data = cmd;
  892. scsi_req(req)->cmd_len = scsi_command_size(pt->pscsi_cdb);
  893. scsi_req(req)->cmd = &pt->pscsi_cdb[0];
  894. if (pdv->pdv_sd->type == TYPE_DISK ||
  895. pdv->pdv_sd->type == TYPE_ZBC)
  896. req->timeout = PS_TIMEOUT_DISK;
  897. else
  898. req->timeout = PS_TIMEOUT_OTHER;
  899. scsi_req(req)->retries = PS_RETRY;
  900. blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, req,
  901. (cmd->sam_task_attr == TCM_HEAD_TAG),
  902. pscsi_req_done);
  903. return 0;
  904. fail_put_request:
  905. blk_put_request(req);
  906. fail:
  907. kfree(pt);
  908. return ret;
  909. }
  910. /* pscsi_get_device_type():
  911. *
  912. *
  913. */
  914. static u32 pscsi_get_device_type(struct se_device *dev)
  915. {
  916. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  917. struct scsi_device *sd = pdv->pdv_sd;
  918. return (sd) ? sd->type : TYPE_NO_LUN;
  919. }
  920. static sector_t pscsi_get_blocks(struct se_device *dev)
  921. {
  922. struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
  923. if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
  924. return pdv->pdv_bd->bd_part->nr_sects;
  925. return 0;
  926. }
  927. static void pscsi_req_done(struct request *req, blk_status_t status)
  928. {
  929. struct se_cmd *cmd = req->end_io_data;
  930. struct pscsi_plugin_task *pt = cmd->priv;
  931. int result = scsi_req(req)->result;
  932. u8 scsi_status = status_byte(result) << 1;
  933. if (scsi_status) {
  934. pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
  935. " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
  936. result);
  937. }
  938. pscsi_complete_cmd(cmd, scsi_status, scsi_req(req)->sense);
  939. switch (host_byte(result)) {
  940. case DID_OK:
  941. target_complete_cmd_with_length(cmd, scsi_status,
  942. cmd->data_length - scsi_req(req)->resid_len);
  943. break;
  944. default:
  945. pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
  946. " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
  947. result);
  948. target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
  949. break;
  950. }
  951. __blk_put_request(req->q, req);
  952. kfree(pt);
  953. }
  954. static const struct target_backend_ops pscsi_ops = {
  955. .name = "pscsi",
  956. .owner = THIS_MODULE,
  957. .transport_flags = TRANSPORT_FLAG_PASSTHROUGH |
  958. TRANSPORT_FLAG_PASSTHROUGH_ALUA |
  959. TRANSPORT_FLAG_PASSTHROUGH_PGR,
  960. .attach_hba = pscsi_attach_hba,
  961. .detach_hba = pscsi_detach_hba,
  962. .pmode_enable_hba = pscsi_pmode_enable_hba,
  963. .alloc_device = pscsi_alloc_device,
  964. .configure_device = pscsi_configure_device,
  965. .destroy_device = pscsi_destroy_device,
  966. .free_device = pscsi_free_device,
  967. .parse_cdb = pscsi_parse_cdb,
  968. .set_configfs_dev_params = pscsi_set_configfs_dev_params,
  969. .show_configfs_dev_params = pscsi_show_configfs_dev_params,
  970. .get_device_type = pscsi_get_device_type,
  971. .get_blocks = pscsi_get_blocks,
  972. .tb_dev_attrib_attrs = passthrough_attrib_attrs,
  973. };
  974. static int __init pscsi_module_init(void)
  975. {
  976. return transport_backend_register(&pscsi_ops);
  977. }
  978. static void __exit pscsi_module_exit(void)
  979. {
  980. target_backend_unregister(&pscsi_ops);
  981. }
  982. MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
  983. MODULE_AUTHOR("nab@Linux-iSCSI.org");
  984. MODULE_LICENSE("GPL");
  985. module_init(pscsi_module_init);
  986. module_exit(pscsi_module_exit);