zfcp_aux.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * zfcp device driver
  4. *
  5. * Module interface and handling of zfcp data structures.
  6. *
  7. * Copyright IBM Corp. 2002, 2020
  8. */
  9. /*
  10. * Driver authors:
  11. * Martin Peschke (originator of the driver)
  12. * Raimund Schroeder
  13. * Aron Zeh
  14. * Wolfgang Taphorn
  15. * Stefan Bader
  16. * Heiko Carstens (kernel 2.6 port of the driver)
  17. * Andreas Herrmann
  18. * Maxim Shchetynin
  19. * Volker Sameske
  20. * Ralph Wuerthner
  21. * Michael Loehr
  22. * Swen Schillig
  23. * Christof Schmitt
  24. * Martin Petermann
  25. * Sven Schuetz
  26. * Steffen Maier
  27. * Benjamin Block
  28. */
  29. #define KMSG_COMPONENT "zfcp"
  30. #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
  31. #include <linux/seq_file.h>
  32. #include <linux/slab.h>
  33. #include <linux/module.h>
  34. #include "zfcp_ext.h"
  35. #include "zfcp_fc.h"
  36. #include "zfcp_reqlist.h"
  37. #include "zfcp_diag.h"
  38. #define ZFCP_BUS_ID_SIZE 20
  39. MODULE_AUTHOR("IBM Deutschland Entwicklung GmbH - linux390@de.ibm.com");
  40. MODULE_DESCRIPTION("FCP HBA driver");
  41. MODULE_LICENSE("GPL");
  42. static char *init_device;
  43. module_param_named(device, init_device, charp, 0400);
  44. MODULE_PARM_DESC(device, "specify initial device");
  45. static struct kmem_cache * __init zfcp_cache_hw_align(const char *name,
  46. unsigned long size)
  47. {
  48. return kmem_cache_create(name, size, roundup_pow_of_two(size), 0, NULL);
  49. }
  50. static void __init zfcp_init_device_configure(char *busid, u64 wwpn, u64 lun)
  51. {
  52. struct ccw_device *cdev;
  53. struct zfcp_adapter *adapter;
  54. struct zfcp_port *port;
  55. cdev = get_ccwdev_by_busid(&zfcp_ccw_driver, busid);
  56. if (!cdev)
  57. return;
  58. if (ccw_device_set_online(cdev))
  59. goto out_ccw_device;
  60. adapter = zfcp_ccw_adapter_by_cdev(cdev);
  61. if (!adapter)
  62. goto out_ccw_device;
  63. port = zfcp_get_port_by_wwpn(adapter, wwpn);
  64. if (!port)
  65. goto out_port;
  66. flush_work(&port->rport_work);
  67. zfcp_unit_add(port, lun);
  68. put_device(&port->dev);
  69. out_port:
  70. zfcp_ccw_adapter_put(adapter);
  71. out_ccw_device:
  72. put_device(&cdev->dev);
  73. return;
  74. }
  75. static void __init zfcp_init_device_setup(char *devstr)
  76. {
  77. char *token;
  78. char *str, *str_saved;
  79. char busid[ZFCP_BUS_ID_SIZE];
  80. u64 wwpn, lun;
  81. /* duplicate devstr and keep the original for sysfs presentation*/
  82. str_saved = kstrdup(devstr, GFP_KERNEL);
  83. str = str_saved;
  84. if (!str)
  85. return;
  86. token = strsep(&str, ",");
  87. if (!token || strlen(token) >= ZFCP_BUS_ID_SIZE)
  88. goto err_out;
  89. strlcpy(busid, token, ZFCP_BUS_ID_SIZE);
  90. token = strsep(&str, ",");
  91. if (!token || kstrtoull(token, 0, (unsigned long long *) &wwpn))
  92. goto err_out;
  93. token = strsep(&str, ",");
  94. if (!token || kstrtoull(token, 0, (unsigned long long *) &lun))
  95. goto err_out;
  96. kfree(str_saved);
  97. zfcp_init_device_configure(busid, wwpn, lun);
  98. return;
  99. err_out:
  100. kfree(str_saved);
  101. pr_err("%s is not a valid SCSI device\n", devstr);
  102. }
  103. static int __init zfcp_module_init(void)
  104. {
  105. int retval = -ENOMEM;
  106. if (zfcp_experimental_dix)
  107. pr_warn("DIX is enabled. It is experimental and might cause problems\n");
  108. zfcp_fsf_qtcb_cache = zfcp_cache_hw_align("zfcp_fsf_qtcb",
  109. sizeof(struct fsf_qtcb));
  110. if (!zfcp_fsf_qtcb_cache)
  111. goto out_qtcb_cache;
  112. zfcp_fc_req_cache = zfcp_cache_hw_align("zfcp_fc_req",
  113. sizeof(struct zfcp_fc_req));
  114. if (!zfcp_fc_req_cache)
  115. goto out_fc_cache;
  116. zfcp_scsi_transport_template =
  117. fc_attach_transport(&zfcp_transport_functions);
  118. if (!zfcp_scsi_transport_template)
  119. goto out_transport;
  120. scsi_transport_reserve_device(zfcp_scsi_transport_template,
  121. sizeof(struct zfcp_scsi_dev));
  122. retval = ccw_driver_register(&zfcp_ccw_driver);
  123. if (retval) {
  124. pr_err("The zfcp device driver could not register with "
  125. "the common I/O layer\n");
  126. goto out_ccw_register;
  127. }
  128. if (init_device)
  129. zfcp_init_device_setup(init_device);
  130. return 0;
  131. out_ccw_register:
  132. fc_release_transport(zfcp_scsi_transport_template);
  133. out_transport:
  134. kmem_cache_destroy(zfcp_fc_req_cache);
  135. out_fc_cache:
  136. kmem_cache_destroy(zfcp_fsf_qtcb_cache);
  137. out_qtcb_cache:
  138. return retval;
  139. }
  140. module_init(zfcp_module_init);
  141. static void __exit zfcp_module_exit(void)
  142. {
  143. ccw_driver_unregister(&zfcp_ccw_driver);
  144. fc_release_transport(zfcp_scsi_transport_template);
  145. kmem_cache_destroy(zfcp_fc_req_cache);
  146. kmem_cache_destroy(zfcp_fsf_qtcb_cache);
  147. }
  148. module_exit(zfcp_module_exit);
  149. /**
  150. * zfcp_get_port_by_wwpn - find port in port list of adapter by wwpn
  151. * @adapter: pointer to adapter to search for port
  152. * @wwpn: wwpn to search for
  153. *
  154. * Returns: pointer to zfcp_port or NULL
  155. */
  156. struct zfcp_port *zfcp_get_port_by_wwpn(struct zfcp_adapter *adapter,
  157. u64 wwpn)
  158. {
  159. unsigned long flags;
  160. struct zfcp_port *port;
  161. read_lock_irqsave(&adapter->port_list_lock, flags);
  162. list_for_each_entry(port, &adapter->port_list, list)
  163. if (port->wwpn == wwpn) {
  164. if (!get_device(&port->dev))
  165. port = NULL;
  166. read_unlock_irqrestore(&adapter->port_list_lock, flags);
  167. return port;
  168. }
  169. read_unlock_irqrestore(&adapter->port_list_lock, flags);
  170. return NULL;
  171. }
  172. static int zfcp_allocate_low_mem_buffers(struct zfcp_adapter *adapter)
  173. {
  174. adapter->pool.erp_req =
  175. mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
  176. if (!adapter->pool.erp_req)
  177. return -ENOMEM;
  178. adapter->pool.gid_pn_req =
  179. mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
  180. if (!adapter->pool.gid_pn_req)
  181. return -ENOMEM;
  182. adapter->pool.scsi_req =
  183. mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
  184. if (!adapter->pool.scsi_req)
  185. return -ENOMEM;
  186. adapter->pool.scsi_abort =
  187. mempool_create_kmalloc_pool(1, sizeof(struct zfcp_fsf_req));
  188. if (!adapter->pool.scsi_abort)
  189. return -ENOMEM;
  190. adapter->pool.status_read_req =
  191. mempool_create_kmalloc_pool(FSF_STATUS_READS_RECOM,
  192. sizeof(struct zfcp_fsf_req));
  193. if (!adapter->pool.status_read_req)
  194. return -ENOMEM;
  195. adapter->pool.qtcb_pool =
  196. mempool_create_slab_pool(4, zfcp_fsf_qtcb_cache);
  197. if (!adapter->pool.qtcb_pool)
  198. return -ENOMEM;
  199. BUILD_BUG_ON(sizeof(struct fsf_status_read_buffer) > PAGE_SIZE);
  200. adapter->pool.sr_data =
  201. mempool_create_page_pool(FSF_STATUS_READS_RECOM, 0);
  202. if (!adapter->pool.sr_data)
  203. return -ENOMEM;
  204. adapter->pool.gid_pn =
  205. mempool_create_slab_pool(1, zfcp_fc_req_cache);
  206. if (!adapter->pool.gid_pn)
  207. return -ENOMEM;
  208. return 0;
  209. }
  210. static void zfcp_free_low_mem_buffers(struct zfcp_adapter *adapter)
  211. {
  212. mempool_destroy(adapter->pool.erp_req);
  213. mempool_destroy(adapter->pool.scsi_req);
  214. mempool_destroy(adapter->pool.scsi_abort);
  215. mempool_destroy(adapter->pool.qtcb_pool);
  216. mempool_destroy(adapter->pool.status_read_req);
  217. mempool_destroy(adapter->pool.sr_data);
  218. mempool_destroy(adapter->pool.gid_pn);
  219. }
  220. /**
  221. * zfcp_status_read_refill - refill the long running status_read_requests
  222. * @adapter: ptr to struct zfcp_adapter for which the buffers should be refilled
  223. *
  224. * Return:
  225. * * 0 on success meaning at least one status read is pending
  226. * * 1 if posting failed and not a single status read buffer is pending,
  227. * also triggers adapter reopen recovery
  228. */
  229. int zfcp_status_read_refill(struct zfcp_adapter *adapter)
  230. {
  231. while (atomic_add_unless(&adapter->stat_miss, -1, 0))
  232. if (zfcp_fsf_status_read(adapter->qdio)) {
  233. atomic_inc(&adapter->stat_miss); /* undo add -1 */
  234. if (atomic_read(&adapter->stat_miss) >=
  235. adapter->stat_read_buf_num) {
  236. zfcp_erp_adapter_reopen(adapter, 0, "axsref1");
  237. return 1;
  238. }
  239. break;
  240. }
  241. return 0;
  242. }
  243. static void _zfcp_status_read_scheduler(struct work_struct *work)
  244. {
  245. zfcp_status_read_refill(container_of(work, struct zfcp_adapter,
  246. stat_work));
  247. }
  248. static void zfcp_print_sl(struct seq_file *m, struct service_level *sl)
  249. {
  250. struct zfcp_adapter *adapter =
  251. container_of(sl, struct zfcp_adapter, service_level);
  252. seq_printf(m, "zfcp: %s microcode level %x\n",
  253. dev_name(&adapter->ccw_device->dev),
  254. adapter->fsf_lic_version);
  255. }
  256. static int zfcp_setup_adapter_work_queue(struct zfcp_adapter *adapter)
  257. {
  258. char name[TASK_COMM_LEN];
  259. snprintf(name, sizeof(name), "zfcp_q_%s",
  260. dev_name(&adapter->ccw_device->dev));
  261. adapter->work_queue = alloc_ordered_workqueue(name, WQ_MEM_RECLAIM);
  262. if (adapter->work_queue)
  263. return 0;
  264. return -ENOMEM;
  265. }
  266. static void zfcp_destroy_adapter_work_queue(struct zfcp_adapter *adapter)
  267. {
  268. if (adapter->work_queue)
  269. destroy_workqueue(adapter->work_queue);
  270. adapter->work_queue = NULL;
  271. }
  272. /**
  273. * zfcp_adapter_enqueue - enqueue a new adapter to the list
  274. * @ccw_device: pointer to the struct cc_device
  275. *
  276. * Returns: struct zfcp_adapter*
  277. * Enqueues an adapter at the end of the adapter list in the driver data.
  278. * All adapter internal structures are set up.
  279. * Proc-fs entries are also created.
  280. */
  281. struct zfcp_adapter *zfcp_adapter_enqueue(struct ccw_device *ccw_device)
  282. {
  283. struct zfcp_adapter *adapter;
  284. if (!get_device(&ccw_device->dev))
  285. return ERR_PTR(-ENODEV);
  286. adapter = kzalloc(sizeof(struct zfcp_adapter), GFP_KERNEL);
  287. if (!adapter) {
  288. put_device(&ccw_device->dev);
  289. return ERR_PTR(-ENOMEM);
  290. }
  291. kref_init(&adapter->ref);
  292. ccw_device->handler = NULL;
  293. adapter->ccw_device = ccw_device;
  294. INIT_WORK(&adapter->stat_work, _zfcp_status_read_scheduler);
  295. INIT_DELAYED_WORK(&adapter->scan_work, zfcp_fc_scan_ports);
  296. INIT_WORK(&adapter->ns_up_work, zfcp_fc_sym_name_update);
  297. adapter->next_port_scan = jiffies;
  298. adapter->erp_action.adapter = adapter;
  299. if (zfcp_diag_adapter_setup(adapter))
  300. goto failed;
  301. if (zfcp_qdio_setup(adapter))
  302. goto failed;
  303. if (zfcp_allocate_low_mem_buffers(adapter))
  304. goto failed;
  305. adapter->req_list = zfcp_reqlist_alloc();
  306. if (!adapter->req_list)
  307. goto failed;
  308. if (zfcp_dbf_adapter_register(adapter))
  309. goto failed;
  310. if (zfcp_setup_adapter_work_queue(adapter))
  311. goto failed;
  312. if (zfcp_fc_gs_setup(adapter))
  313. goto failed;
  314. rwlock_init(&adapter->port_list_lock);
  315. INIT_LIST_HEAD(&adapter->port_list);
  316. INIT_LIST_HEAD(&adapter->events.list);
  317. INIT_WORK(&adapter->events.work, zfcp_fc_post_event);
  318. spin_lock_init(&adapter->events.list_lock);
  319. init_waitqueue_head(&adapter->erp_ready_wq);
  320. init_waitqueue_head(&adapter->erp_done_wqh);
  321. INIT_LIST_HEAD(&adapter->erp_ready_head);
  322. INIT_LIST_HEAD(&adapter->erp_running_head);
  323. rwlock_init(&adapter->erp_lock);
  324. rwlock_init(&adapter->abort_lock);
  325. if (zfcp_erp_thread_setup(adapter))
  326. goto failed;
  327. adapter->service_level.seq_print = zfcp_print_sl;
  328. dev_set_drvdata(&ccw_device->dev, adapter);
  329. if (sysfs_create_group(&ccw_device->dev.kobj,
  330. &zfcp_sysfs_adapter_attrs))
  331. goto failed;
  332. if (zfcp_diag_sysfs_setup(adapter))
  333. goto failed;
  334. /* report size limit per scatter-gather segment */
  335. adapter->ccw_device->dev.dma_parms = &adapter->dma_parms;
  336. adapter->stat_read_buf_num = FSF_STATUS_READS_RECOM;
  337. return adapter;
  338. failed:
  339. zfcp_adapter_unregister(adapter);
  340. return ERR_PTR(-ENOMEM);
  341. }
  342. void zfcp_adapter_unregister(struct zfcp_adapter *adapter)
  343. {
  344. struct ccw_device *cdev = adapter->ccw_device;
  345. cancel_delayed_work_sync(&adapter->scan_work);
  346. cancel_work_sync(&adapter->stat_work);
  347. cancel_work_sync(&adapter->ns_up_work);
  348. zfcp_destroy_adapter_work_queue(adapter);
  349. zfcp_fc_wka_ports_force_offline(adapter->gs);
  350. zfcp_scsi_adapter_unregister(adapter);
  351. zfcp_diag_sysfs_destroy(adapter);
  352. sysfs_remove_group(&cdev->dev.kobj, &zfcp_sysfs_adapter_attrs);
  353. zfcp_erp_thread_kill(adapter);
  354. zfcp_dbf_adapter_unregister(adapter);
  355. zfcp_qdio_destroy(adapter->qdio);
  356. zfcp_ccw_adapter_put(adapter); /* final put to release */
  357. }
  358. /**
  359. * zfcp_adapter_release - remove the adapter from the resource list
  360. * @ref: pointer to struct kref
  361. * locks: adapter list write lock is assumed to be held by caller
  362. */
  363. void zfcp_adapter_release(struct kref *ref)
  364. {
  365. struct zfcp_adapter *adapter = container_of(ref, struct zfcp_adapter,
  366. ref);
  367. struct ccw_device *cdev = adapter->ccw_device;
  368. dev_set_drvdata(&adapter->ccw_device->dev, NULL);
  369. zfcp_fc_gs_destroy(adapter);
  370. zfcp_free_low_mem_buffers(adapter);
  371. zfcp_diag_adapter_free(adapter);
  372. kfree(adapter->req_list);
  373. kfree(adapter->fc_stats);
  374. kfree(adapter->stats_reset_data);
  375. kfree(adapter);
  376. put_device(&cdev->dev);
  377. }
  378. static void zfcp_port_release(struct device *dev)
  379. {
  380. struct zfcp_port *port = container_of(dev, struct zfcp_port, dev);
  381. zfcp_ccw_adapter_put(port->adapter);
  382. kfree(port);
  383. }
  384. /**
  385. * zfcp_port_enqueue - enqueue port to port list of adapter
  386. * @adapter: adapter where remote port is added
  387. * @wwpn: WWPN of the remote port to be enqueued
  388. * @status: initial status for the port
  389. * @d_id: destination id of the remote port to be enqueued
  390. * Returns: pointer to enqueued port on success, ERR_PTR on error
  391. *
  392. * All port internal structures are set up and the sysfs entry is generated.
  393. * d_id is used to enqueue ports with a well known address like the Directory
  394. * Service for nameserver lookup.
  395. */
  396. struct zfcp_port *zfcp_port_enqueue(struct zfcp_adapter *adapter, u64 wwpn,
  397. u32 status, u32 d_id)
  398. {
  399. struct zfcp_port *port;
  400. int retval = -ENOMEM;
  401. kref_get(&adapter->ref);
  402. port = zfcp_get_port_by_wwpn(adapter, wwpn);
  403. if (port) {
  404. put_device(&port->dev);
  405. retval = -EEXIST;
  406. goto err_out;
  407. }
  408. port = kzalloc(sizeof(struct zfcp_port), GFP_KERNEL);
  409. if (!port)
  410. goto err_out;
  411. rwlock_init(&port->unit_list_lock);
  412. INIT_LIST_HEAD(&port->unit_list);
  413. atomic_set(&port->units, 0);
  414. INIT_WORK(&port->gid_pn_work, zfcp_fc_port_did_lookup);
  415. INIT_WORK(&port->test_link_work, zfcp_fc_link_test_work);
  416. INIT_WORK(&port->rport_work, zfcp_scsi_rport_work);
  417. port->adapter = adapter;
  418. port->d_id = d_id;
  419. port->wwpn = wwpn;
  420. port->rport_task = RPORT_NONE;
  421. port->dev.parent = &adapter->ccw_device->dev;
  422. port->dev.groups = zfcp_port_attr_groups;
  423. port->dev.release = zfcp_port_release;
  424. port->erp_action.adapter = adapter;
  425. port->erp_action.port = port;
  426. if (dev_set_name(&port->dev, "0x%016llx", (unsigned long long)wwpn)) {
  427. kfree(port);
  428. goto err_out;
  429. }
  430. retval = -EINVAL;
  431. if (device_register(&port->dev)) {
  432. put_device(&port->dev);
  433. goto err_out;
  434. }
  435. write_lock_irq(&adapter->port_list_lock);
  436. list_add_tail(&port->list, &adapter->port_list);
  437. write_unlock_irq(&adapter->port_list_lock);
  438. atomic_or(status | ZFCP_STATUS_COMMON_RUNNING, &port->status);
  439. return port;
  440. err_out:
  441. zfcp_ccw_adapter_put(adapter);
  442. return ERR_PTR(retval);
  443. }