blk-lib.c 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Functions related to generic helpers functions
  4. */
  5. #include <linux/kernel.h>
  6. #include <linux/module.h>
  7. #include <linux/bio.h>
  8. #include <linux/blkdev.h>
  9. #include <linux/scatterlist.h>
  10. #include "blk.h"
  11. static sector_t bio_discard_limit(struct block_device *bdev, sector_t sector)
  12. {
  13. unsigned int discard_granularity = bdev_discard_granularity(bdev);
  14. sector_t granularity_aligned_sector;
  15. if (bdev_is_partition(bdev))
  16. sector += bdev->bd_start_sect;
  17. granularity_aligned_sector =
  18. round_up(sector, discard_granularity >> SECTOR_SHIFT);
  19. /*
  20. * Make sure subsequent bios start aligned to the discard granularity if
  21. * it needs to be split.
  22. */
  23. if (granularity_aligned_sector != sector)
  24. return granularity_aligned_sector - sector;
  25. /*
  26. * Align the bio size to the discard granularity to make splitting the bio
  27. * at discard granularity boundaries easier in the driver if needed.
  28. */
  29. return round_down(UINT_MAX, discard_granularity) >> SECTOR_SHIFT;
  30. }
  31. int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
  32. sector_t nr_sects, gfp_t gfp_mask, struct bio **biop)
  33. {
  34. struct bio *bio = *biop;
  35. sector_t bs_mask;
  36. if (bdev_read_only(bdev))
  37. return -EPERM;
  38. if (!bdev_max_discard_sectors(bdev))
  39. return -EOPNOTSUPP;
  40. /* In case the discard granularity isn't set by buggy device driver */
  41. if (WARN_ON_ONCE(!bdev_discard_granularity(bdev))) {
  42. pr_err_ratelimited("%pg: Error: discard_granularity is 0.\n",
  43. bdev);
  44. return -EOPNOTSUPP;
  45. }
  46. bs_mask = (bdev_logical_block_size(bdev) >> 9) - 1;
  47. if ((sector | nr_sects) & bs_mask)
  48. return -EINVAL;
  49. if (!nr_sects)
  50. return -EINVAL;
  51. while (nr_sects) {
  52. sector_t req_sects =
  53. min(nr_sects, bio_discard_limit(bdev, sector));
  54. bio = blk_next_bio(bio, bdev, 0, REQ_OP_DISCARD, gfp_mask);
  55. bio->bi_iter.bi_sector = sector;
  56. bio->bi_iter.bi_size = req_sects << 9;
  57. sector += req_sects;
  58. nr_sects -= req_sects;
  59. /*
  60. * We can loop for a long time in here, if someone does
  61. * full device discards (like mkfs). Be nice and allow
  62. * us to schedule out to avoid softlocking if preempt
  63. * is disabled.
  64. */
  65. cond_resched();
  66. }
  67. *biop = bio;
  68. return 0;
  69. }
  70. EXPORT_SYMBOL(__blkdev_issue_discard);
  71. /**
  72. * blkdev_issue_discard - queue a discard
  73. * @bdev: blockdev to issue discard for
  74. * @sector: start sector
  75. * @nr_sects: number of sectors to discard
  76. * @gfp_mask: memory allocation flags (for bio_alloc)
  77. *
  78. * Description:
  79. * Issue a discard request for the sectors in question.
  80. */
  81. int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
  82. sector_t nr_sects, gfp_t gfp_mask)
  83. {
  84. struct bio *bio = NULL;
  85. struct blk_plug plug;
  86. int ret;
  87. blk_start_plug(&plug);
  88. ret = __blkdev_issue_discard(bdev, sector, nr_sects, gfp_mask, &bio);
  89. if (!ret && bio) {
  90. ret = submit_bio_wait(bio);
  91. if (ret == -EOPNOTSUPP)
  92. ret = 0;
  93. bio_put(bio);
  94. }
  95. blk_finish_plug(&plug);
  96. return ret;
  97. }
  98. EXPORT_SYMBOL(blkdev_issue_discard);
  99. static int __blkdev_issue_write_zeroes(struct block_device *bdev,
  100. sector_t sector, sector_t nr_sects, gfp_t gfp_mask,
  101. struct bio **biop, unsigned flags)
  102. {
  103. struct bio *bio = *biop;
  104. unsigned int max_write_zeroes_sectors;
  105. if (bdev_read_only(bdev))
  106. return -EPERM;
  107. /* Ensure that max_write_zeroes_sectors doesn't overflow bi_size */
  108. max_write_zeroes_sectors = bdev_write_zeroes_sectors(bdev);
  109. if (max_write_zeroes_sectors == 0)
  110. return -EOPNOTSUPP;
  111. while (nr_sects) {
  112. bio = blk_next_bio(bio, bdev, 0, REQ_OP_WRITE_ZEROES, gfp_mask);
  113. bio->bi_iter.bi_sector = sector;
  114. if (flags & BLKDEV_ZERO_NOUNMAP)
  115. bio->bi_opf |= REQ_NOUNMAP;
  116. if (nr_sects > max_write_zeroes_sectors) {
  117. bio->bi_iter.bi_size = max_write_zeroes_sectors << 9;
  118. nr_sects -= max_write_zeroes_sectors;
  119. sector += max_write_zeroes_sectors;
  120. } else {
  121. bio->bi_iter.bi_size = nr_sects << 9;
  122. nr_sects = 0;
  123. }
  124. cond_resched();
  125. }
  126. *biop = bio;
  127. return 0;
  128. }
  129. /*
  130. * Convert a number of 512B sectors to a number of pages.
  131. * The result is limited to a number of pages that can fit into a BIO.
  132. * Also make sure that the result is always at least 1 (page) for the cases
  133. * where nr_sects is lower than the number of sectors in a page.
  134. */
  135. static unsigned int __blkdev_sectors_to_bio_pages(sector_t nr_sects)
  136. {
  137. sector_t pages = DIV_ROUND_UP_SECTOR_T(nr_sects, PAGE_SIZE / 512);
  138. return min(pages, (sector_t)BIO_MAX_VECS);
  139. }
  140. static int __blkdev_issue_zero_pages(struct block_device *bdev,
  141. sector_t sector, sector_t nr_sects, gfp_t gfp_mask,
  142. struct bio **biop)
  143. {
  144. struct bio *bio = *biop;
  145. int bi_size = 0;
  146. unsigned int sz;
  147. if (bdev_read_only(bdev))
  148. return -EPERM;
  149. while (nr_sects != 0) {
  150. bio = blk_next_bio(bio, bdev, __blkdev_sectors_to_bio_pages(nr_sects),
  151. REQ_OP_WRITE, gfp_mask);
  152. bio->bi_iter.bi_sector = sector;
  153. while (nr_sects != 0) {
  154. sz = min((sector_t) PAGE_SIZE, nr_sects << 9);
  155. bi_size = bio_add_page(bio, ZERO_PAGE(0), sz, 0);
  156. nr_sects -= bi_size >> 9;
  157. sector += bi_size >> 9;
  158. if (bi_size < sz)
  159. break;
  160. }
  161. cond_resched();
  162. }
  163. *biop = bio;
  164. return 0;
  165. }
  166. /**
  167. * __blkdev_issue_zeroout - generate number of zero filed write bios
  168. * @bdev: blockdev to issue
  169. * @sector: start sector
  170. * @nr_sects: number of sectors to write
  171. * @gfp_mask: memory allocation flags (for bio_alloc)
  172. * @biop: pointer to anchor bio
  173. * @flags: controls detailed behavior
  174. *
  175. * Description:
  176. * Zero-fill a block range, either using hardware offload or by explicitly
  177. * writing zeroes to the device.
  178. *
  179. * If a device is using logical block provisioning, the underlying space will
  180. * not be released if %flags contains BLKDEV_ZERO_NOUNMAP.
  181. *
  182. * If %flags contains BLKDEV_ZERO_NOFALLBACK, the function will return
  183. * -EOPNOTSUPP if no explicit hardware offload for zeroing is provided.
  184. */
  185. int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
  186. sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
  187. unsigned flags)
  188. {
  189. int ret;
  190. sector_t bs_mask;
  191. bs_mask = (bdev_logical_block_size(bdev) >> 9) - 1;
  192. if ((sector | nr_sects) & bs_mask)
  193. return -EINVAL;
  194. ret = __blkdev_issue_write_zeroes(bdev, sector, nr_sects, gfp_mask,
  195. biop, flags);
  196. if (ret != -EOPNOTSUPP || (flags & BLKDEV_ZERO_NOFALLBACK))
  197. return ret;
  198. return __blkdev_issue_zero_pages(bdev, sector, nr_sects, gfp_mask,
  199. biop);
  200. }
  201. EXPORT_SYMBOL(__blkdev_issue_zeroout);
  202. /**
  203. * blkdev_issue_zeroout - zero-fill a block range
  204. * @bdev: blockdev to write
  205. * @sector: start sector
  206. * @nr_sects: number of sectors to write
  207. * @gfp_mask: memory allocation flags (for bio_alloc)
  208. * @flags: controls detailed behavior
  209. *
  210. * Description:
  211. * Zero-fill a block range, either using hardware offload or by explicitly
  212. * writing zeroes to the device. See __blkdev_issue_zeroout() for the
  213. * valid values for %flags.
  214. */
  215. int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
  216. sector_t nr_sects, gfp_t gfp_mask, unsigned flags)
  217. {
  218. int ret = 0;
  219. sector_t bs_mask;
  220. struct bio *bio;
  221. struct blk_plug plug;
  222. bool try_write_zeroes = !!bdev_write_zeroes_sectors(bdev);
  223. bs_mask = (bdev_logical_block_size(bdev) >> 9) - 1;
  224. if ((sector | nr_sects) & bs_mask)
  225. return -EINVAL;
  226. retry:
  227. bio = NULL;
  228. blk_start_plug(&plug);
  229. if (try_write_zeroes) {
  230. ret = __blkdev_issue_write_zeroes(bdev, sector, nr_sects,
  231. gfp_mask, &bio, flags);
  232. } else if (!(flags & BLKDEV_ZERO_NOFALLBACK)) {
  233. ret = __blkdev_issue_zero_pages(bdev, sector, nr_sects,
  234. gfp_mask, &bio);
  235. } else {
  236. /* No zeroing offload support */
  237. ret = -EOPNOTSUPP;
  238. }
  239. if (ret == 0 && bio) {
  240. ret = submit_bio_wait(bio);
  241. bio_put(bio);
  242. }
  243. blk_finish_plug(&plug);
  244. if (ret && try_write_zeroes) {
  245. if (!(flags & BLKDEV_ZERO_NOFALLBACK)) {
  246. try_write_zeroes = false;
  247. goto retry;
  248. }
  249. if (!bdev_write_zeroes_sectors(bdev)) {
  250. /*
  251. * Zeroing offload support was indicated, but the
  252. * device reported ILLEGAL REQUEST (for some devices
  253. * there is no non-destructive way to verify whether
  254. * WRITE ZEROES is actually supported).
  255. */
  256. ret = -EOPNOTSUPP;
  257. }
  258. }
  259. return ret;
  260. }
  261. EXPORT_SYMBOL(blkdev_issue_zeroout);
  262. int blkdev_issue_secure_erase(struct block_device *bdev, sector_t sector,
  263. sector_t nr_sects, gfp_t gfp)
  264. {
  265. sector_t bs_mask = (bdev_logical_block_size(bdev) >> 9) - 1;
  266. unsigned int max_sectors = bdev_max_secure_erase_sectors(bdev);
  267. struct bio *bio = NULL;
  268. struct blk_plug plug;
  269. int ret = 0;
  270. /* make sure that "len << SECTOR_SHIFT" doesn't overflow */
  271. if (max_sectors > UINT_MAX >> SECTOR_SHIFT)
  272. max_sectors = UINT_MAX >> SECTOR_SHIFT;
  273. max_sectors &= ~bs_mask;
  274. if (max_sectors == 0)
  275. return -EOPNOTSUPP;
  276. if ((sector | nr_sects) & bs_mask)
  277. return -EINVAL;
  278. if (bdev_read_only(bdev))
  279. return -EPERM;
  280. blk_start_plug(&plug);
  281. for (;;) {
  282. unsigned int len = min_t(sector_t, nr_sects, max_sectors);
  283. bio = blk_next_bio(bio, bdev, 0, REQ_OP_SECURE_ERASE, gfp);
  284. bio->bi_iter.bi_sector = sector;
  285. bio->bi_iter.bi_size = len << SECTOR_SHIFT;
  286. sector += len;
  287. nr_sects -= len;
  288. if (!nr_sects) {
  289. ret = submit_bio_wait(bio);
  290. bio_put(bio);
  291. break;
  292. }
  293. cond_resched();
  294. }
  295. blk_finish_plug(&plug);
  296. return ret;
  297. }
  298. EXPORT_SYMBOL(blkdev_issue_secure_erase);