nbd.c 23 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042
  1. /*
  2. * Network block device - make block devices work over TCP
  3. *
  4. * Note that you can not swap over this thing, yet. Seems to work but
  5. * deadlocks sometimes - you can not swap over TCP in general.
  6. *
  7. * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.cz>
  8. * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
  9. *
  10. * This file is released under GPLv2 or later.
  11. *
  12. * (part of code stolen from loop.c)
  13. */
  14. #include <linux/major.h>
  15. #include <linux/blkdev.h>
  16. #include <linux/module.h>
  17. #include <linux/init.h>
  18. #include <linux/sched.h>
  19. #include <linux/fs.h>
  20. #include <linux/bio.h>
  21. #include <linux/stat.h>
  22. #include <linux/errno.h>
  23. #include <linux/file.h>
  24. #include <linux/ioctl.h>
  25. #include <linux/mutex.h>
  26. #include <linux/compiler.h>
  27. #include <linux/err.h>
  28. #include <linux/kernel.h>
  29. #include <linux/slab.h>
  30. #include <net/sock.h>
  31. #include <linux/net.h>
  32. #include <linux/kthread.h>
  33. #include <linux/types.h>
  34. #include <linux/debugfs.h>
  35. #include <linux/blk-mq.h>
  36. #include <asm/uaccess.h>
  37. #include <asm/types.h>
  38. #include <linux/nbd.h>
  39. #define NBD_TIMEDOUT 0
  40. #define NBD_DISCONNECT_REQUESTED 1
  41. struct nbd_device {
  42. u32 flags;
  43. unsigned long runtime_flags;
  44. struct socket * sock; /* If == NULL, device is not ready, yet */
  45. int magic;
  46. struct blk_mq_tag_set tag_set;
  47. struct mutex tx_lock;
  48. struct gendisk *disk;
  49. loff_t blksize;
  50. loff_t bytesize;
  51. /* protects initialization and shutdown of the socket */
  52. spinlock_t sock_lock;
  53. struct task_struct *task_recv;
  54. struct task_struct *task_send;
  55. #if IS_ENABLED(CONFIG_DEBUG_FS)
  56. struct dentry *dbg_dir;
  57. #endif
  58. };
  59. struct nbd_cmd {
  60. struct nbd_device *nbd;
  61. struct list_head list;
  62. };
  63. #if IS_ENABLED(CONFIG_DEBUG_FS)
  64. static struct dentry *nbd_dbg_dir;
  65. #endif
  66. #define nbd_name(nbd) ((nbd)->disk->disk_name)
  67. #define NBD_MAGIC 0x68797548
  68. static unsigned int nbds_max = 16;
  69. static struct nbd_device *nbd_dev;
  70. static int max_part;
  71. static inline struct device *nbd_to_dev(struct nbd_device *nbd)
  72. {
  73. return disk_to_dev(nbd->disk);
  74. }
  75. static bool nbd_is_connected(struct nbd_device *nbd)
  76. {
  77. return !!nbd->task_recv;
  78. }
  79. static const char *nbdcmd_to_ascii(int cmd)
  80. {
  81. switch (cmd) {
  82. case NBD_CMD_READ: return "read";
  83. case NBD_CMD_WRITE: return "write";
  84. case NBD_CMD_DISC: return "disconnect";
  85. case NBD_CMD_FLUSH: return "flush";
  86. case NBD_CMD_TRIM: return "trim/discard";
  87. }
  88. return "invalid";
  89. }
  90. static int nbd_size_clear(struct nbd_device *nbd, struct block_device *bdev)
  91. {
  92. bdev->bd_inode->i_size = 0;
  93. set_capacity(nbd->disk, 0);
  94. kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
  95. return 0;
  96. }
  97. static void nbd_size_update(struct nbd_device *nbd, struct block_device *bdev)
  98. {
  99. if (!nbd_is_connected(nbd))
  100. return;
  101. bdev->bd_inode->i_size = nbd->bytesize;
  102. set_capacity(nbd->disk, nbd->bytesize >> 9);
  103. kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
  104. }
  105. static int nbd_size_set(struct nbd_device *nbd, struct block_device *bdev,
  106. loff_t blocksize, loff_t nr_blocks)
  107. {
  108. int ret;
  109. ret = set_blocksize(bdev, blocksize);
  110. if (ret)
  111. return ret;
  112. nbd->blksize = blocksize;
  113. nbd->bytesize = blocksize * nr_blocks;
  114. nbd_size_update(nbd, bdev);
  115. return 0;
  116. }
  117. static void nbd_end_request(struct nbd_cmd *cmd)
  118. {
  119. struct nbd_device *nbd = cmd->nbd;
  120. struct request *req = blk_mq_rq_from_pdu(cmd);
  121. int error = req->errors ? -EIO : 0;
  122. dev_dbg(nbd_to_dev(nbd), "request %p: %s\n", cmd,
  123. error ? "failed" : "done");
  124. blk_mq_complete_request(req, error);
  125. }
  126. /*
  127. * Forcibly shutdown the socket causing all listeners to error
  128. */
  129. static void sock_shutdown(struct nbd_device *nbd)
  130. {
  131. struct socket *sock;
  132. spin_lock(&nbd->sock_lock);
  133. if (!nbd->sock) {
  134. spin_unlock(&nbd->sock_lock);
  135. return;
  136. }
  137. sock = nbd->sock;
  138. dev_warn(disk_to_dev(nbd->disk), "shutting down socket\n");
  139. nbd->sock = NULL;
  140. spin_unlock(&nbd->sock_lock);
  141. kernel_sock_shutdown(sock, SHUT_RDWR);
  142. sockfd_put(sock);
  143. }
  144. static enum blk_eh_timer_return nbd_xmit_timeout(struct request *req,
  145. bool reserved)
  146. {
  147. struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
  148. struct nbd_device *nbd = cmd->nbd;
  149. struct socket *sock = NULL;
  150. spin_lock(&nbd->sock_lock);
  151. set_bit(NBD_TIMEDOUT, &nbd->runtime_flags);
  152. if (nbd->sock) {
  153. sock = nbd->sock;
  154. get_file(sock->file);
  155. }
  156. spin_unlock(&nbd->sock_lock);
  157. if (sock) {
  158. kernel_sock_shutdown(sock, SHUT_RDWR);
  159. sockfd_put(sock);
  160. }
  161. req->errors++;
  162. dev_err(nbd_to_dev(nbd), "Connection timed out, shutting down connection\n");
  163. return BLK_EH_HANDLED;
  164. }
  165. /*
  166. * Send or receive packet.
  167. */
  168. static int sock_xmit(struct nbd_device *nbd, int send, void *buf, int size,
  169. int msg_flags)
  170. {
  171. struct socket *sock = nbd->sock;
  172. int result;
  173. struct msghdr msg;
  174. struct kvec iov;
  175. unsigned long pflags = current->flags;
  176. if (unlikely(!sock)) {
  177. dev_err(disk_to_dev(nbd->disk),
  178. "Attempted %s on closed socket in sock_xmit\n",
  179. (send ? "send" : "recv"));
  180. return -EINVAL;
  181. }
  182. current->flags |= PF_MEMALLOC;
  183. do {
  184. sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
  185. iov.iov_base = buf;
  186. iov.iov_len = size;
  187. msg.msg_name = NULL;
  188. msg.msg_namelen = 0;
  189. msg.msg_control = NULL;
  190. msg.msg_controllen = 0;
  191. msg.msg_flags = msg_flags | MSG_NOSIGNAL;
  192. if (send)
  193. result = kernel_sendmsg(sock, &msg, &iov, 1, size);
  194. else
  195. result = kernel_recvmsg(sock, &msg, &iov, 1, size,
  196. msg.msg_flags);
  197. if (result <= 0) {
  198. if (result == 0)
  199. result = -EPIPE; /* short read */
  200. break;
  201. }
  202. size -= result;
  203. buf += result;
  204. } while (size > 0);
  205. tsk_restore_flags(current, pflags, PF_MEMALLOC);
  206. return result;
  207. }
  208. static inline int sock_send_bvec(struct nbd_device *nbd, struct bio_vec *bvec,
  209. int flags)
  210. {
  211. int result;
  212. void *kaddr = kmap(bvec->bv_page);
  213. result = sock_xmit(nbd, 1, kaddr + bvec->bv_offset,
  214. bvec->bv_len, flags);
  215. kunmap(bvec->bv_page);
  216. return result;
  217. }
  218. /* always call with the tx_lock held */
  219. static int nbd_send_cmd(struct nbd_device *nbd, struct nbd_cmd *cmd)
  220. {
  221. struct request *req = blk_mq_rq_from_pdu(cmd);
  222. int result, flags;
  223. struct nbd_request request;
  224. unsigned long size = blk_rq_bytes(req);
  225. u32 type;
  226. if (req->cmd_type == REQ_TYPE_DRV_PRIV)
  227. type = NBD_CMD_DISC;
  228. else if (req_op(req) == REQ_OP_DISCARD)
  229. type = NBD_CMD_TRIM;
  230. else if (req_op(req) == REQ_OP_FLUSH)
  231. type = NBD_CMD_FLUSH;
  232. else if (rq_data_dir(req) == WRITE)
  233. type = NBD_CMD_WRITE;
  234. else
  235. type = NBD_CMD_READ;
  236. memset(&request, 0, sizeof(request));
  237. request.magic = htonl(NBD_REQUEST_MAGIC);
  238. request.type = htonl(type);
  239. if (type != NBD_CMD_FLUSH && type != NBD_CMD_DISC) {
  240. request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
  241. request.len = htonl(size);
  242. }
  243. memcpy(request.handle, &req->tag, sizeof(req->tag));
  244. dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
  245. cmd, nbdcmd_to_ascii(type),
  246. (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
  247. result = sock_xmit(nbd, 1, &request, sizeof(request),
  248. (type == NBD_CMD_WRITE) ? MSG_MORE : 0);
  249. if (result <= 0) {
  250. dev_err(disk_to_dev(nbd->disk),
  251. "Send control failed (result %d)\n", result);
  252. return -EIO;
  253. }
  254. if (type == NBD_CMD_WRITE) {
  255. struct req_iterator iter;
  256. struct bio_vec bvec;
  257. /*
  258. * we are really probing at internals to determine
  259. * whether to set MSG_MORE or not...
  260. */
  261. rq_for_each_segment(bvec, req, iter) {
  262. flags = 0;
  263. if (!rq_iter_last(bvec, iter))
  264. flags = MSG_MORE;
  265. dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
  266. cmd, bvec.bv_len);
  267. result = sock_send_bvec(nbd, &bvec, flags);
  268. if (result <= 0) {
  269. dev_err(disk_to_dev(nbd->disk),
  270. "Send data failed (result %d)\n",
  271. result);
  272. return -EIO;
  273. }
  274. }
  275. }
  276. return 0;
  277. }
  278. static inline int sock_recv_bvec(struct nbd_device *nbd, struct bio_vec *bvec)
  279. {
  280. int result;
  281. void *kaddr = kmap(bvec->bv_page);
  282. result = sock_xmit(nbd, 0, kaddr + bvec->bv_offset, bvec->bv_len,
  283. MSG_WAITALL);
  284. kunmap(bvec->bv_page);
  285. return result;
  286. }
  287. /* NULL returned = something went wrong, inform userspace */
  288. static struct nbd_cmd *nbd_read_stat(struct nbd_device *nbd)
  289. {
  290. int result;
  291. struct nbd_reply reply;
  292. struct nbd_cmd *cmd;
  293. struct request *req = NULL;
  294. u16 hwq;
  295. int tag;
  296. reply.magic = 0;
  297. result = sock_xmit(nbd, 0, &reply, sizeof(reply), MSG_WAITALL);
  298. if (result <= 0) {
  299. dev_err(disk_to_dev(nbd->disk),
  300. "Receive control failed (result %d)\n", result);
  301. return ERR_PTR(result);
  302. }
  303. if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
  304. dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
  305. (unsigned long)ntohl(reply.magic));
  306. return ERR_PTR(-EPROTO);
  307. }
  308. memcpy(&tag, reply.handle, sizeof(int));
  309. hwq = blk_mq_unique_tag_to_hwq(tag);
  310. if (hwq < nbd->tag_set.nr_hw_queues)
  311. req = blk_mq_tag_to_rq(nbd->tag_set.tags[hwq],
  312. blk_mq_unique_tag_to_tag(tag));
  313. if (!req || !blk_mq_request_started(req)) {
  314. dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%d) %p\n",
  315. tag, req);
  316. return ERR_PTR(-ENOENT);
  317. }
  318. cmd = blk_mq_rq_to_pdu(req);
  319. if (ntohl(reply.error)) {
  320. dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
  321. ntohl(reply.error));
  322. req->errors++;
  323. return cmd;
  324. }
  325. dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", cmd);
  326. if (rq_data_dir(req) != WRITE) {
  327. struct req_iterator iter;
  328. struct bio_vec bvec;
  329. rq_for_each_segment(bvec, req, iter) {
  330. result = sock_recv_bvec(nbd, &bvec);
  331. if (result <= 0) {
  332. dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
  333. result);
  334. req->errors++;
  335. return cmd;
  336. }
  337. dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
  338. cmd, bvec.bv_len);
  339. }
  340. }
  341. return cmd;
  342. }
  343. static ssize_t pid_show(struct device *dev,
  344. struct device_attribute *attr, char *buf)
  345. {
  346. struct gendisk *disk = dev_to_disk(dev);
  347. struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
  348. return sprintf(buf, "%d\n", task_pid_nr(nbd->task_recv));
  349. }
  350. static struct device_attribute pid_attr = {
  351. .attr = { .name = "pid", .mode = S_IRUGO},
  352. .show = pid_show,
  353. };
  354. static int nbd_thread_recv(struct nbd_device *nbd, struct block_device *bdev)
  355. {
  356. struct nbd_cmd *cmd;
  357. int ret;
  358. BUG_ON(nbd->magic != NBD_MAGIC);
  359. sk_set_memalloc(nbd->sock->sk);
  360. ret = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
  361. if (ret) {
  362. dev_err(disk_to_dev(nbd->disk), "device_create_file failed!\n");
  363. return ret;
  364. }
  365. nbd_size_update(nbd, bdev);
  366. while (1) {
  367. cmd = nbd_read_stat(nbd);
  368. if (IS_ERR(cmd)) {
  369. ret = PTR_ERR(cmd);
  370. break;
  371. }
  372. nbd_end_request(cmd);
  373. }
  374. nbd_size_clear(nbd, bdev);
  375. device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
  376. return ret;
  377. }
  378. static void nbd_clear_req(struct request *req, void *data, bool reserved)
  379. {
  380. struct nbd_cmd *cmd;
  381. if (!blk_mq_request_started(req))
  382. return;
  383. cmd = blk_mq_rq_to_pdu(req);
  384. req->errors++;
  385. nbd_end_request(cmd);
  386. }
  387. static void nbd_clear_que(struct nbd_device *nbd)
  388. {
  389. BUG_ON(nbd->magic != NBD_MAGIC);
  390. /*
  391. * Because we have set nbd->sock to NULL under the tx_lock, all
  392. * modifications to the list must have completed by now.
  393. */
  394. BUG_ON(nbd->sock);
  395. blk_mq_tagset_busy_iter(&nbd->tag_set, nbd_clear_req, NULL);
  396. dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
  397. }
  398. static void nbd_handle_cmd(struct nbd_cmd *cmd)
  399. {
  400. struct request *req = blk_mq_rq_from_pdu(cmd);
  401. struct nbd_device *nbd = cmd->nbd;
  402. if (req->cmd_type != REQ_TYPE_FS)
  403. goto error_out;
  404. if (rq_data_dir(req) == WRITE &&
  405. (nbd->flags & NBD_FLAG_READ_ONLY)) {
  406. dev_err(disk_to_dev(nbd->disk),
  407. "Write on read-only\n");
  408. goto error_out;
  409. }
  410. req->errors = 0;
  411. mutex_lock(&nbd->tx_lock);
  412. nbd->task_send = current;
  413. if (unlikely(!nbd->sock)) {
  414. mutex_unlock(&nbd->tx_lock);
  415. dev_err(disk_to_dev(nbd->disk),
  416. "Attempted send on closed socket\n");
  417. goto error_out;
  418. }
  419. if (nbd_send_cmd(nbd, cmd) != 0) {
  420. dev_err(disk_to_dev(nbd->disk), "Request send failed\n");
  421. req->errors++;
  422. nbd_end_request(cmd);
  423. }
  424. nbd->task_send = NULL;
  425. mutex_unlock(&nbd->tx_lock);
  426. return;
  427. error_out:
  428. req->errors++;
  429. nbd_end_request(cmd);
  430. }
  431. static int nbd_queue_rq(struct blk_mq_hw_ctx *hctx,
  432. const struct blk_mq_queue_data *bd)
  433. {
  434. struct nbd_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
  435. blk_mq_start_request(bd->rq);
  436. nbd_handle_cmd(cmd);
  437. return BLK_MQ_RQ_QUEUE_OK;
  438. }
  439. static int nbd_set_socket(struct nbd_device *nbd, struct socket *sock)
  440. {
  441. int ret = 0;
  442. spin_lock_irq(&nbd->sock_lock);
  443. if (nbd->sock) {
  444. ret = -EBUSY;
  445. goto out;
  446. }
  447. nbd->sock = sock;
  448. out:
  449. spin_unlock_irq(&nbd->sock_lock);
  450. return ret;
  451. }
  452. /* Reset all properties of an NBD device */
  453. static void nbd_reset(struct nbd_device *nbd)
  454. {
  455. nbd->runtime_flags = 0;
  456. nbd->blksize = 1024;
  457. nbd->bytesize = 0;
  458. set_capacity(nbd->disk, 0);
  459. nbd->flags = 0;
  460. nbd->tag_set.timeout = 0;
  461. queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
  462. }
  463. static void nbd_bdev_reset(struct block_device *bdev)
  464. {
  465. set_device_ro(bdev, false);
  466. bdev->bd_inode->i_size = 0;
  467. if (max_part > 0) {
  468. blkdev_reread_part(bdev);
  469. bdev->bd_invalidated = 1;
  470. }
  471. }
  472. static void nbd_parse_flags(struct nbd_device *nbd, struct block_device *bdev)
  473. {
  474. if (nbd->flags & NBD_FLAG_READ_ONLY)
  475. set_device_ro(bdev, true);
  476. if (nbd->flags & NBD_FLAG_SEND_TRIM)
  477. queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
  478. if (nbd->flags & NBD_FLAG_SEND_FLUSH)
  479. blk_queue_write_cache(nbd->disk->queue, true, false);
  480. else
  481. blk_queue_write_cache(nbd->disk->queue, false, false);
  482. }
  483. static int nbd_dev_dbg_init(struct nbd_device *nbd);
  484. static void nbd_dev_dbg_close(struct nbd_device *nbd);
  485. /* Must be called with tx_lock held */
  486. static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
  487. unsigned int cmd, unsigned long arg)
  488. {
  489. switch (cmd) {
  490. case NBD_DISCONNECT: {
  491. struct request *sreq;
  492. dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
  493. if (!nbd->sock)
  494. return -EINVAL;
  495. sreq = blk_mq_alloc_request(bdev_get_queue(bdev), WRITE, 0);
  496. if (IS_ERR(sreq))
  497. return -ENOMEM;
  498. mutex_unlock(&nbd->tx_lock);
  499. fsync_bdev(bdev);
  500. mutex_lock(&nbd->tx_lock);
  501. sreq->cmd_type = REQ_TYPE_DRV_PRIV;
  502. /* Check again after getting mutex back. */
  503. if (!nbd->sock) {
  504. blk_mq_free_request(sreq);
  505. return -EINVAL;
  506. }
  507. set_bit(NBD_DISCONNECT_REQUESTED, &nbd->runtime_flags);
  508. nbd_send_cmd(nbd, blk_mq_rq_to_pdu(sreq));
  509. blk_mq_free_request(sreq);
  510. return 0;
  511. }
  512. case NBD_CLEAR_SOCK:
  513. sock_shutdown(nbd);
  514. nbd_clear_que(nbd);
  515. kill_bdev(bdev);
  516. return 0;
  517. case NBD_SET_SOCK: {
  518. int err;
  519. struct socket *sock = sockfd_lookup(arg, &err);
  520. if (!sock)
  521. return err;
  522. err = nbd_set_socket(nbd, sock);
  523. if (!err && max_part)
  524. bdev->bd_invalidated = 1;
  525. return err;
  526. }
  527. case NBD_SET_BLKSIZE: {
  528. loff_t bsize = div_s64(nbd->bytesize, arg);
  529. return nbd_size_set(nbd, bdev, arg, bsize);
  530. }
  531. case NBD_SET_SIZE:
  532. return nbd_size_set(nbd, bdev, nbd->blksize,
  533. div_s64(arg, nbd->blksize));
  534. case NBD_SET_SIZE_BLOCKS:
  535. return nbd_size_set(nbd, bdev, nbd->blksize, arg);
  536. case NBD_SET_TIMEOUT:
  537. nbd->tag_set.timeout = arg * HZ;
  538. return 0;
  539. case NBD_SET_FLAGS:
  540. nbd->flags = arg;
  541. return 0;
  542. case NBD_DO_IT: {
  543. int error;
  544. if (nbd->task_recv)
  545. return -EBUSY;
  546. if (!nbd->sock)
  547. return -EINVAL;
  548. /* We have to claim the device under the lock */
  549. nbd->task_recv = current;
  550. mutex_unlock(&nbd->tx_lock);
  551. nbd_parse_flags(nbd, bdev);
  552. nbd_dev_dbg_init(nbd);
  553. error = nbd_thread_recv(nbd, bdev);
  554. nbd_dev_dbg_close(nbd);
  555. mutex_lock(&nbd->tx_lock);
  556. nbd->task_recv = NULL;
  557. sock_shutdown(nbd);
  558. nbd_clear_que(nbd);
  559. kill_bdev(bdev);
  560. nbd_bdev_reset(bdev);
  561. /* user requested, ignore socket errors */
  562. if (test_bit(NBD_DISCONNECT_REQUESTED, &nbd->runtime_flags))
  563. error = 0;
  564. if (test_bit(NBD_TIMEDOUT, &nbd->runtime_flags))
  565. error = -ETIMEDOUT;
  566. nbd_reset(nbd);
  567. return error;
  568. }
  569. case NBD_CLEAR_QUE:
  570. /*
  571. * This is for compatibility only. The queue is always cleared
  572. * by NBD_DO_IT or NBD_CLEAR_SOCK.
  573. */
  574. return 0;
  575. case NBD_PRINT_DEBUG:
  576. /*
  577. * For compatibility only, we no longer keep a list of
  578. * outstanding requests.
  579. */
  580. return 0;
  581. }
  582. return -ENOTTY;
  583. }
  584. static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
  585. unsigned int cmd, unsigned long arg)
  586. {
  587. struct nbd_device *nbd = bdev->bd_disk->private_data;
  588. int error;
  589. if (!capable(CAP_SYS_ADMIN))
  590. return -EPERM;
  591. BUG_ON(nbd->magic != NBD_MAGIC);
  592. mutex_lock(&nbd->tx_lock);
  593. error = __nbd_ioctl(bdev, nbd, cmd, arg);
  594. mutex_unlock(&nbd->tx_lock);
  595. return error;
  596. }
  597. static const struct block_device_operations nbd_fops =
  598. {
  599. .owner = THIS_MODULE,
  600. .ioctl = nbd_ioctl,
  601. .compat_ioctl = nbd_ioctl,
  602. };
  603. #if IS_ENABLED(CONFIG_DEBUG_FS)
  604. static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
  605. {
  606. struct nbd_device *nbd = s->private;
  607. if (nbd->task_recv)
  608. seq_printf(s, "recv: %d\n", task_pid_nr(nbd->task_recv));
  609. if (nbd->task_send)
  610. seq_printf(s, "send: %d\n", task_pid_nr(nbd->task_send));
  611. return 0;
  612. }
  613. static int nbd_dbg_tasks_open(struct inode *inode, struct file *file)
  614. {
  615. return single_open(file, nbd_dbg_tasks_show, inode->i_private);
  616. }
  617. static const struct file_operations nbd_dbg_tasks_ops = {
  618. .open = nbd_dbg_tasks_open,
  619. .read = seq_read,
  620. .llseek = seq_lseek,
  621. .release = single_release,
  622. };
  623. static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
  624. {
  625. struct nbd_device *nbd = s->private;
  626. u32 flags = nbd->flags;
  627. seq_printf(s, "Hex: 0x%08x\n\n", flags);
  628. seq_puts(s, "Known flags:\n");
  629. if (flags & NBD_FLAG_HAS_FLAGS)
  630. seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
  631. if (flags & NBD_FLAG_READ_ONLY)
  632. seq_puts(s, "NBD_FLAG_READ_ONLY\n");
  633. if (flags & NBD_FLAG_SEND_FLUSH)
  634. seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
  635. if (flags & NBD_FLAG_SEND_TRIM)
  636. seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
  637. return 0;
  638. }
  639. static int nbd_dbg_flags_open(struct inode *inode, struct file *file)
  640. {
  641. return single_open(file, nbd_dbg_flags_show, inode->i_private);
  642. }
  643. static const struct file_operations nbd_dbg_flags_ops = {
  644. .open = nbd_dbg_flags_open,
  645. .read = seq_read,
  646. .llseek = seq_lseek,
  647. .release = single_release,
  648. };
  649. static int nbd_dev_dbg_init(struct nbd_device *nbd)
  650. {
  651. struct dentry *dir;
  652. if (!nbd_dbg_dir)
  653. return -EIO;
  654. dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
  655. if (!dir) {
  656. dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
  657. nbd_name(nbd));
  658. return -EIO;
  659. }
  660. nbd->dbg_dir = dir;
  661. debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_ops);
  662. debugfs_create_u64("size_bytes", 0444, dir, &nbd->bytesize);
  663. debugfs_create_u32("timeout", 0444, dir, &nbd->tag_set.timeout);
  664. debugfs_create_u64("blocksize", 0444, dir, &nbd->blksize);
  665. debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_ops);
  666. return 0;
  667. }
  668. static void nbd_dev_dbg_close(struct nbd_device *nbd)
  669. {
  670. debugfs_remove_recursive(nbd->dbg_dir);
  671. }
  672. static int nbd_dbg_init(void)
  673. {
  674. struct dentry *dbg_dir;
  675. dbg_dir = debugfs_create_dir("nbd", NULL);
  676. if (!dbg_dir)
  677. return -EIO;
  678. nbd_dbg_dir = dbg_dir;
  679. return 0;
  680. }
  681. static void nbd_dbg_close(void)
  682. {
  683. debugfs_remove_recursive(nbd_dbg_dir);
  684. }
  685. #else /* IS_ENABLED(CONFIG_DEBUG_FS) */
  686. static int nbd_dev_dbg_init(struct nbd_device *nbd)
  687. {
  688. return 0;
  689. }
  690. static void nbd_dev_dbg_close(struct nbd_device *nbd)
  691. {
  692. }
  693. static int nbd_dbg_init(void)
  694. {
  695. return 0;
  696. }
  697. static void nbd_dbg_close(void)
  698. {
  699. }
  700. #endif
  701. static int nbd_init_request(void *data, struct request *rq,
  702. unsigned int hctx_idx, unsigned int request_idx,
  703. unsigned int numa_node)
  704. {
  705. struct nbd_cmd *cmd = blk_mq_rq_to_pdu(rq);
  706. cmd->nbd = data;
  707. INIT_LIST_HEAD(&cmd->list);
  708. return 0;
  709. }
  710. static struct blk_mq_ops nbd_mq_ops = {
  711. .queue_rq = nbd_queue_rq,
  712. .init_request = nbd_init_request,
  713. .timeout = nbd_xmit_timeout,
  714. };
  715. /*
  716. * And here should be modules and kernel interface
  717. * (Just smiley confuses emacs :-)
  718. */
  719. static int __init nbd_init(void)
  720. {
  721. int err = -ENOMEM;
  722. int i;
  723. int part_shift;
  724. BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
  725. if (max_part < 0) {
  726. printk(KERN_ERR "nbd: max_part must be >= 0\n");
  727. return -EINVAL;
  728. }
  729. part_shift = 0;
  730. if (max_part > 0) {
  731. part_shift = fls(max_part);
  732. /*
  733. * Adjust max_part according to part_shift as it is exported
  734. * to user space so that user can know the max number of
  735. * partition kernel should be able to manage.
  736. *
  737. * Note that -1 is required because partition 0 is reserved
  738. * for the whole disk.
  739. */
  740. max_part = (1UL << part_shift) - 1;
  741. }
  742. if ((1UL << part_shift) > DISK_MAX_PARTS)
  743. return -EINVAL;
  744. if (nbds_max > 1UL << (MINORBITS - part_shift))
  745. return -EINVAL;
  746. nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
  747. if (!nbd_dev)
  748. return -ENOMEM;
  749. for (i = 0; i < nbds_max; i++) {
  750. struct request_queue *q;
  751. struct gendisk *disk = alloc_disk(1 << part_shift);
  752. if (!disk)
  753. goto out;
  754. nbd_dev[i].disk = disk;
  755. nbd_dev[i].tag_set.ops = &nbd_mq_ops;
  756. nbd_dev[i].tag_set.nr_hw_queues = 1;
  757. nbd_dev[i].tag_set.queue_depth = 128;
  758. nbd_dev[i].tag_set.numa_node = NUMA_NO_NODE;
  759. nbd_dev[i].tag_set.cmd_size = sizeof(struct nbd_cmd);
  760. nbd_dev[i].tag_set.flags = BLK_MQ_F_SHOULD_MERGE |
  761. BLK_MQ_F_SG_MERGE | BLK_MQ_F_BLOCKING;
  762. nbd_dev[i].tag_set.driver_data = &nbd_dev[i];
  763. err = blk_mq_alloc_tag_set(&nbd_dev[i].tag_set);
  764. if (err) {
  765. put_disk(disk);
  766. goto out;
  767. }
  768. /*
  769. * The new linux 2.5 block layer implementation requires
  770. * every gendisk to have its very own request_queue struct.
  771. * These structs are big so we dynamically allocate them.
  772. */
  773. q = blk_mq_init_queue(&nbd_dev[i].tag_set);
  774. if (IS_ERR(q)) {
  775. blk_mq_free_tag_set(&nbd_dev[i].tag_set);
  776. put_disk(disk);
  777. goto out;
  778. }
  779. disk->queue = q;
  780. /*
  781. * Tell the block layer that we are not a rotational device
  782. */
  783. queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
  784. queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, disk->queue);
  785. disk->queue->limits.discard_granularity = 512;
  786. blk_queue_max_discard_sectors(disk->queue, UINT_MAX);
  787. disk->queue->limits.discard_zeroes_data = 0;
  788. blk_queue_max_hw_sectors(disk->queue, 65536);
  789. disk->queue->limits.max_sectors = 256;
  790. }
  791. if (register_blkdev(NBD_MAJOR, "nbd")) {
  792. err = -EIO;
  793. goto out;
  794. }
  795. printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
  796. nbd_dbg_init();
  797. for (i = 0; i < nbds_max; i++) {
  798. struct gendisk *disk = nbd_dev[i].disk;
  799. nbd_dev[i].magic = NBD_MAGIC;
  800. spin_lock_init(&nbd_dev[i].sock_lock);
  801. mutex_init(&nbd_dev[i].tx_lock);
  802. disk->major = NBD_MAJOR;
  803. disk->first_minor = i << part_shift;
  804. disk->fops = &nbd_fops;
  805. disk->private_data = &nbd_dev[i];
  806. sprintf(disk->disk_name, "nbd%d", i);
  807. nbd_reset(&nbd_dev[i]);
  808. add_disk(disk);
  809. }
  810. return 0;
  811. out:
  812. while (i--) {
  813. blk_mq_free_tag_set(&nbd_dev[i].tag_set);
  814. blk_cleanup_queue(nbd_dev[i].disk->queue);
  815. put_disk(nbd_dev[i].disk);
  816. }
  817. kfree(nbd_dev);
  818. return err;
  819. }
  820. static void __exit nbd_cleanup(void)
  821. {
  822. int i;
  823. nbd_dbg_close();
  824. for (i = 0; i < nbds_max; i++) {
  825. struct gendisk *disk = nbd_dev[i].disk;
  826. nbd_dev[i].magic = 0;
  827. if (disk) {
  828. del_gendisk(disk);
  829. blk_cleanup_queue(disk->queue);
  830. blk_mq_free_tag_set(&nbd_dev[i].tag_set);
  831. put_disk(disk);
  832. }
  833. }
  834. unregister_blkdev(NBD_MAJOR, "nbd");
  835. kfree(nbd_dev);
  836. printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
  837. }
  838. module_init(nbd_init);
  839. module_exit(nbd_cleanup);
  840. MODULE_DESCRIPTION("Network Block Device");
  841. MODULE_LICENSE("GPL");
  842. module_param(nbds_max, int, 0444);
  843. MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
  844. module_param(max_part, int, 0444);
  845. MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");