stub_main.c 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright (C) 2003-2008 Takahiro Hirofuchi
  4. */
  5. #include <linux/string.h>
  6. #include <linux/module.h>
  7. #include <linux/device.h>
  8. #include <linux/scatterlist.h>
  9. #include "usbip_common.h"
  10. #include "stub.h"
  11. #define DRIVER_AUTHOR "Takahiro Hirofuchi"
  12. #define DRIVER_DESC "USB/IP Host Driver"
  13. struct kmem_cache *stub_priv_cache;
  14. /*
  15. * busid_tables defines matching busids that usbip can grab. A user can change
  16. * dynamically what device is locally used and what device is exported to a
  17. * remote host.
  18. */
  19. #define MAX_BUSID 16
  20. static struct bus_id_priv busid_table[MAX_BUSID];
  21. static DEFINE_SPINLOCK(busid_table_lock);
  22. static void init_busid_table(void)
  23. {
  24. int i;
  25. /*
  26. * This also sets the bus_table[i].status to
  27. * STUB_BUSID_OTHER, which is 0.
  28. */
  29. memset(busid_table, 0, sizeof(busid_table));
  30. for (i = 0; i < MAX_BUSID; i++)
  31. spin_lock_init(&busid_table[i].busid_lock);
  32. }
  33. /*
  34. * Find the index of the busid by name.
  35. * Must be called with busid_table_lock held.
  36. */
  37. static int get_busid_idx(const char *busid)
  38. {
  39. int i;
  40. int idx = -1;
  41. for (i = 0; i < MAX_BUSID; i++) {
  42. spin_lock(&busid_table[i].busid_lock);
  43. if (busid_table[i].name[0])
  44. if (!strncmp(busid_table[i].name, busid, BUSID_SIZE)) {
  45. idx = i;
  46. spin_unlock(&busid_table[i].busid_lock);
  47. break;
  48. }
  49. spin_unlock(&busid_table[i].busid_lock);
  50. }
  51. return idx;
  52. }
  53. /* Returns holding busid_lock. Should call put_busid_priv() to unlock */
  54. struct bus_id_priv *get_busid_priv(const char *busid)
  55. {
  56. int idx;
  57. struct bus_id_priv *bid = NULL;
  58. spin_lock(&busid_table_lock);
  59. idx = get_busid_idx(busid);
  60. if (idx >= 0) {
  61. bid = &(busid_table[idx]);
  62. /* get busid_lock before returning */
  63. spin_lock(&bid->busid_lock);
  64. }
  65. spin_unlock(&busid_table_lock);
  66. return bid;
  67. }
  68. void put_busid_priv(struct bus_id_priv *bid)
  69. {
  70. if (bid)
  71. spin_unlock(&bid->busid_lock);
  72. }
  73. static int add_match_busid(char *busid)
  74. {
  75. int i;
  76. int ret = -1;
  77. spin_lock(&busid_table_lock);
  78. /* already registered? */
  79. if (get_busid_idx(busid) >= 0) {
  80. ret = 0;
  81. goto out;
  82. }
  83. for (i = 0; i < MAX_BUSID; i++) {
  84. spin_lock(&busid_table[i].busid_lock);
  85. if (!busid_table[i].name[0]) {
  86. strscpy(busid_table[i].name, busid, BUSID_SIZE);
  87. if ((busid_table[i].status != STUB_BUSID_ALLOC) &&
  88. (busid_table[i].status != STUB_BUSID_REMOV))
  89. busid_table[i].status = STUB_BUSID_ADDED;
  90. ret = 0;
  91. spin_unlock(&busid_table[i].busid_lock);
  92. break;
  93. }
  94. spin_unlock(&busid_table[i].busid_lock);
  95. }
  96. out:
  97. spin_unlock(&busid_table_lock);
  98. return ret;
  99. }
  100. int del_match_busid(char *busid)
  101. {
  102. int idx;
  103. int ret = -1;
  104. spin_lock(&busid_table_lock);
  105. idx = get_busid_idx(busid);
  106. if (idx < 0)
  107. goto out;
  108. /* found */
  109. ret = 0;
  110. spin_lock(&busid_table[idx].busid_lock);
  111. if (busid_table[idx].status == STUB_BUSID_OTHER)
  112. memset(busid_table[idx].name, 0, BUSID_SIZE);
  113. if ((busid_table[idx].status != STUB_BUSID_OTHER) &&
  114. (busid_table[idx].status != STUB_BUSID_ADDED))
  115. busid_table[idx].status = STUB_BUSID_REMOV;
  116. spin_unlock(&busid_table[idx].busid_lock);
  117. out:
  118. spin_unlock(&busid_table_lock);
  119. return ret;
  120. }
  121. static ssize_t match_busid_show(struct device_driver *drv, char *buf)
  122. {
  123. int i;
  124. char *out = buf;
  125. spin_lock(&busid_table_lock);
  126. for (i = 0; i < MAX_BUSID; i++) {
  127. spin_lock(&busid_table[i].busid_lock);
  128. if (busid_table[i].name[0])
  129. out += sprintf(out, "%s ", busid_table[i].name);
  130. spin_unlock(&busid_table[i].busid_lock);
  131. }
  132. spin_unlock(&busid_table_lock);
  133. out += sprintf(out, "\n");
  134. return out - buf;
  135. }
  136. static ssize_t match_busid_store(struct device_driver *dev, const char *buf,
  137. size_t count)
  138. {
  139. int len;
  140. char busid[BUSID_SIZE];
  141. if (count < 5)
  142. return -EINVAL;
  143. /* busid needs to include \0 termination */
  144. len = strlcpy(busid, buf + 4, BUSID_SIZE);
  145. if (sizeof(busid) <= len)
  146. return -EINVAL;
  147. if (!strncmp(buf, "add ", 4)) {
  148. if (add_match_busid(busid) < 0)
  149. return -ENOMEM;
  150. pr_debug("add busid %s\n", busid);
  151. return count;
  152. }
  153. if (!strncmp(buf, "del ", 4)) {
  154. if (del_match_busid(busid) < 0)
  155. return -ENODEV;
  156. pr_debug("del busid %s\n", busid);
  157. return count;
  158. }
  159. return -EINVAL;
  160. }
  161. static DRIVER_ATTR_RW(match_busid);
  162. static int do_rebind(char *busid, struct bus_id_priv *busid_priv)
  163. {
  164. int ret = 0;
  165. /* device_attach() callers should hold parent lock for USB */
  166. if (busid_priv->udev->dev.parent)
  167. device_lock(busid_priv->udev->dev.parent);
  168. ret = device_attach(&busid_priv->udev->dev);
  169. if (busid_priv->udev->dev.parent)
  170. device_unlock(busid_priv->udev->dev.parent);
  171. if (ret < 0)
  172. dev_err(&busid_priv->udev->dev, "rebind failed\n");
  173. return ret;
  174. }
  175. static void stub_device_rebind(void)
  176. {
  177. #if IS_MODULE(CONFIG_USBIP_HOST)
  178. struct bus_id_priv *busid_priv;
  179. int i;
  180. /* update status to STUB_BUSID_OTHER so probe ignores the device */
  181. spin_lock(&busid_table_lock);
  182. for (i = 0; i < MAX_BUSID; i++) {
  183. if (busid_table[i].name[0] &&
  184. busid_table[i].shutdown_busid) {
  185. busid_priv = &(busid_table[i]);
  186. busid_priv->status = STUB_BUSID_OTHER;
  187. }
  188. }
  189. spin_unlock(&busid_table_lock);
  190. /* now run rebind - no need to hold locks. driver files are removed */
  191. for (i = 0; i < MAX_BUSID; i++) {
  192. if (busid_table[i].name[0] &&
  193. busid_table[i].shutdown_busid) {
  194. busid_priv = &(busid_table[i]);
  195. do_rebind(busid_table[i].name, busid_priv);
  196. }
  197. }
  198. #endif
  199. }
  200. static ssize_t rebind_store(struct device_driver *dev, const char *buf,
  201. size_t count)
  202. {
  203. int ret;
  204. int len;
  205. struct bus_id_priv *bid;
  206. /* buf length should be less that BUSID_SIZE */
  207. len = strnlen(buf, BUSID_SIZE);
  208. if (!(len < BUSID_SIZE))
  209. return -EINVAL;
  210. bid = get_busid_priv(buf);
  211. if (!bid)
  212. return -ENODEV;
  213. /* mark the device for deletion so probe ignores it during rescan */
  214. bid->status = STUB_BUSID_OTHER;
  215. /* release the busid lock */
  216. put_busid_priv(bid);
  217. ret = do_rebind((char *) buf, bid);
  218. if (ret < 0)
  219. return ret;
  220. /* delete device from busid_table */
  221. del_match_busid((char *) buf);
  222. return count;
  223. }
  224. static DRIVER_ATTR_WO(rebind);
  225. static struct stub_priv *stub_priv_pop_from_listhead(struct list_head *listhead)
  226. {
  227. struct stub_priv *priv, *tmp;
  228. list_for_each_entry_safe(priv, tmp, listhead, list) {
  229. list_del_init(&priv->list);
  230. return priv;
  231. }
  232. return NULL;
  233. }
  234. void stub_free_priv_and_urb(struct stub_priv *priv)
  235. {
  236. struct urb *urb;
  237. int i;
  238. for (i = 0; i < priv->num_urbs; i++) {
  239. urb = priv->urbs[i];
  240. if (!urb)
  241. return;
  242. kfree(urb->setup_packet);
  243. urb->setup_packet = NULL;
  244. if (urb->transfer_buffer && !priv->sgl) {
  245. kfree(urb->transfer_buffer);
  246. urb->transfer_buffer = NULL;
  247. }
  248. if (urb->num_sgs) {
  249. sgl_free(urb->sg);
  250. urb->sg = NULL;
  251. urb->num_sgs = 0;
  252. }
  253. usb_free_urb(urb);
  254. }
  255. if (!list_empty(&priv->list))
  256. list_del(&priv->list);
  257. if (priv->sgl)
  258. sgl_free(priv->sgl);
  259. kfree(priv->urbs);
  260. kmem_cache_free(stub_priv_cache, priv);
  261. }
  262. static struct stub_priv *stub_priv_pop(struct stub_device *sdev)
  263. {
  264. unsigned long flags;
  265. struct stub_priv *priv;
  266. spin_lock_irqsave(&sdev->priv_lock, flags);
  267. priv = stub_priv_pop_from_listhead(&sdev->priv_init);
  268. if (priv)
  269. goto done;
  270. priv = stub_priv_pop_from_listhead(&sdev->priv_tx);
  271. if (priv)
  272. goto done;
  273. priv = stub_priv_pop_from_listhead(&sdev->priv_free);
  274. done:
  275. spin_unlock_irqrestore(&sdev->priv_lock, flags);
  276. return priv;
  277. }
  278. void stub_device_cleanup_urbs(struct stub_device *sdev)
  279. {
  280. struct stub_priv *priv;
  281. int i;
  282. dev_dbg(&sdev->udev->dev, "Stub device cleaning up urbs\n");
  283. while ((priv = stub_priv_pop(sdev))) {
  284. for (i = 0; i < priv->num_urbs; i++)
  285. usb_kill_urb(priv->urbs[i]);
  286. stub_free_priv_and_urb(priv);
  287. }
  288. }
  289. static int __init usbip_host_init(void)
  290. {
  291. int ret;
  292. init_busid_table();
  293. stub_priv_cache = KMEM_CACHE(stub_priv, SLAB_HWCACHE_ALIGN);
  294. if (!stub_priv_cache) {
  295. pr_err("kmem_cache_create failed\n");
  296. return -ENOMEM;
  297. }
  298. ret = usb_register_device_driver(&stub_driver, THIS_MODULE);
  299. if (ret) {
  300. pr_err("usb_register failed %d\n", ret);
  301. goto err_usb_register;
  302. }
  303. ret = driver_create_file(&stub_driver.drvwrap.driver,
  304. &driver_attr_match_busid);
  305. if (ret) {
  306. pr_err("driver_create_file failed\n");
  307. goto err_create_file;
  308. }
  309. ret = driver_create_file(&stub_driver.drvwrap.driver,
  310. &driver_attr_rebind);
  311. if (ret) {
  312. pr_err("driver_create_file failed\n");
  313. goto err_create_file;
  314. }
  315. return ret;
  316. err_create_file:
  317. usb_deregister_device_driver(&stub_driver);
  318. err_usb_register:
  319. kmem_cache_destroy(stub_priv_cache);
  320. return ret;
  321. }
  322. static void __exit usbip_host_exit(void)
  323. {
  324. driver_remove_file(&stub_driver.drvwrap.driver,
  325. &driver_attr_match_busid);
  326. driver_remove_file(&stub_driver.drvwrap.driver,
  327. &driver_attr_rebind);
  328. /*
  329. * deregister() calls stub_disconnect() for all devices. Device
  330. * specific data is cleared in stub_disconnect().
  331. */
  332. usb_deregister_device_driver(&stub_driver);
  333. /* initiate scan to attach devices */
  334. stub_device_rebind();
  335. kmem_cache_destroy(stub_priv_cache);
  336. }
  337. module_init(usbip_host_init);
  338. module_exit(usbip_host_exit);
  339. MODULE_AUTHOR(DRIVER_AUTHOR);
  340. MODULE_DESCRIPTION(DRIVER_DESC);
  341. MODULE_LICENSE("GPL");