1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
7 * Swap reorganised 29.12.95,
8 * Asynchronous swapping added 30.12.95. Stephen Tweedie
9 * Removed race in async swapping. 14.4.1996. Bruno Haible
10 * Add swap of shared pages through the page cache. 20.2.1998. Stephen Tweedie
11 * Always use brw_page, life becomes simpler. 12 May 1998 Eric Biederman
15 #include <linux/kernel_stat.h>
16 #include <linux/gfp.h>
17 #include <linux/pagemap.h>
18 #include <linux/swap.h>
19 #include <linux/bio.h>
20 #include <linux/swapops.h>
21 #include <linux/writeback.h>
22 #include <linux/frontswap.h>
23 #include <linux/blkdev.h>
24 #include <linux/psi.h>
25 #include <linux/uio.h>
26 #include <linux/sched/task.h>
27 #include <linux/delayacct.h>
30 static void __end_swap_bio_write(struct bio *bio)
32 struct folio *folio = bio_first_folio_all(bio);
36 * We failed to write the page out to swap-space.
37 * Re-dirty the page in order to avoid it being reclaimed.
38 * Also print a dire warning that things will go BAD (tm)
41 * Also clear PG_reclaim to avoid folio_rotate_reclaimable()
43 folio_mark_dirty(folio);
44 pr_alert_ratelimited("Write-error on swap-device (%u:%u:%llu)\n",
45 MAJOR(bio_dev(bio)), MINOR(bio_dev(bio)),
46 (unsigned long long)bio->bi_iter.bi_sector);
47 folio_clear_reclaim(folio);
49 folio_end_writeback(folio);
52 static void end_swap_bio_write(struct bio *bio)
54 __end_swap_bio_write(bio);
58 static void __end_swap_bio_read(struct bio *bio)
60 struct page *page = bio_first_page_all(bio);
63 pr_alert_ratelimited("Read-error on swap-device (%u:%u:%llu)\n",
64 MAJOR(bio_dev(bio)), MINOR(bio_dev(bio)),
65 (unsigned long long)bio->bi_iter.bi_sector);
67 SetPageUptodate(page);
72 static void end_swap_bio_read(struct bio *bio)
74 __end_swap_bio_read(bio);
78 int generic_swapfile_activate(struct swap_info_struct *sis,
79 struct file *swap_file,
82 struct address_space *mapping = swap_file->f_mapping;
83 struct inode *inode = mapping->host;
84 unsigned blocks_per_page;
85 unsigned long page_no;
89 sector_t lowest_block = -1;
90 sector_t highest_block = 0;
94 blkbits = inode->i_blkbits;
95 blocks_per_page = PAGE_SIZE >> blkbits;
98 * Map all the blocks into the extent tree. This code doesn't try
103 last_block = i_size_read(inode) >> blkbits;
104 while ((probe_block + blocks_per_page) <= last_block &&
105 page_no < sis->max) {
106 unsigned block_in_page;
107 sector_t first_block;
111 first_block = probe_block;
112 ret = bmap(inode, &first_block);
113 if (ret || !first_block)
117 * It must be PAGE_SIZE aligned on-disk
119 if (first_block & (blocks_per_page - 1)) {
124 for (block_in_page = 1; block_in_page < blocks_per_page;
128 block = probe_block + block_in_page;
129 ret = bmap(inode, &block);
133 if (block != first_block + block_in_page) {
140 first_block >>= (PAGE_SHIFT - blkbits);
141 if (page_no) { /* exclude the header page */
142 if (first_block < lowest_block)
143 lowest_block = first_block;
144 if (first_block > highest_block)
145 highest_block = first_block;
149 * We found a PAGE_SIZE-length, PAGE_SIZE-aligned run of blocks
151 ret = add_swap_extent(sis, page_no, 1, first_block);
156 probe_block += blocks_per_page;
161 *span = 1 + highest_block - lowest_block;
163 page_no = 1; /* force Empty message */
165 sis->pages = page_no - 1;
166 sis->highest_bit = page_no - 1;
170 pr_err("swapon: swapfile has holes\n");
176 * We may have stale swap cache pages in memory: notice
177 * them here and get rid of the unnecessary final write.
179 int swap_writepage(struct page *page, struct writeback_control *wbc)
181 struct folio *folio = page_folio(page);
184 if (folio_free_swap(folio)) {
189 * Arch code may have to preserve more data than just the page
190 * contents, e.g. memory tags.
192 ret = arch_prepare_to_swap(&folio->page);
194 folio_mark_dirty(folio);
198 if (frontswap_store(&folio->page) == 0) {
199 folio_start_writeback(folio);
201 folio_end_writeback(folio);
204 __swap_writepage(&folio->page, wbc);
208 static inline void count_swpout_vm_event(struct page *page)
210 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
211 if (unlikely(PageTransHuge(page)))
212 count_vm_event(THP_SWPOUT);
214 count_vm_events(PSWPOUT, thp_nr_pages(page));
217 #if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
218 static void bio_associate_blkg_from_page(struct bio *bio, struct page *page)
220 struct cgroup_subsys_state *css;
221 struct mem_cgroup *memcg;
223 memcg = page_memcg(page);
228 css = cgroup_e_css(memcg->css.cgroup, &io_cgrp_subsys);
229 bio_associate_blkg_from_css(bio, css);
233 #define bio_associate_blkg_from_page(bio, page) do { } while (0)
234 #endif /* CONFIG_MEMCG && CONFIG_BLK_CGROUP */
238 struct bio_vec bvec[SWAP_CLUSTER_MAX];
242 static mempool_t *sio_pool;
244 int sio_pool_init(void)
247 mempool_t *pool = mempool_create_kmalloc_pool(
248 SWAP_CLUSTER_MAX, sizeof(struct swap_iocb));
249 if (cmpxchg(&sio_pool, NULL, pool))
250 mempool_destroy(pool);
257 static void sio_write_complete(struct kiocb *iocb, long ret)
259 struct swap_iocb *sio = container_of(iocb, struct swap_iocb, iocb);
260 struct page *page = sio->bvec[0].bv_page;
263 if (ret != sio->len) {
265 * In the case of swap-over-nfs, this can be a
266 * temporary failure if the system has limited
267 * memory for allocating transmit buffers.
268 * Mark the page dirty and avoid
269 * folio_rotate_reclaimable but rate-limit the
270 * messages but do not flag PageError like
271 * the normal direct-to-bio case as it could
274 pr_err_ratelimited("Write error %ld on dio swapfile (%llu)\n",
275 ret, page_file_offset(page));
276 for (p = 0; p < sio->pages; p++) {
277 page = sio->bvec[p].bv_page;
278 set_page_dirty(page);
279 ClearPageReclaim(page);
282 for (p = 0; p < sio->pages; p++)
283 count_swpout_vm_event(sio->bvec[p].bv_page);
286 for (p = 0; p < sio->pages; p++)
287 end_page_writeback(sio->bvec[p].bv_page);
289 mempool_free(sio, sio_pool);
292 static void swap_writepage_fs(struct page *page, struct writeback_control *wbc)
294 struct swap_iocb *sio = NULL;
295 struct swap_info_struct *sis = page_swap_info(page);
296 struct file *swap_file = sis->swap_file;
297 loff_t pos = page_file_offset(page);
299 set_page_writeback(page);
302 sio = *wbc->swap_plug;
304 if (sio->iocb.ki_filp != swap_file ||
305 sio->iocb.ki_pos + sio->len != pos) {
306 swap_write_unplug(sio);
311 sio = mempool_alloc(sio_pool, GFP_NOIO);
312 init_sync_kiocb(&sio->iocb, swap_file);
313 sio->iocb.ki_complete = sio_write_complete;
314 sio->iocb.ki_pos = pos;
318 bvec_set_page(&sio->bvec[sio->pages], page, thp_size(page), 0);
319 sio->len += thp_size(page);
321 if (sio->pages == ARRAY_SIZE(sio->bvec) || !wbc->swap_plug) {
322 swap_write_unplug(sio);
326 *wbc->swap_plug = sio;
329 static void swap_writepage_bdev_sync(struct page *page,
330 struct writeback_control *wbc, struct swap_info_struct *sis)
335 bio_init(&bio, sis->bdev, &bv, 1,
336 REQ_OP_WRITE | REQ_SWAP | wbc_to_write_flags(wbc));
337 bio.bi_iter.bi_sector = swap_page_sector(page);
338 __bio_add_page(&bio, page, thp_size(page), 0);
340 bio_associate_blkg_from_page(&bio, page);
341 count_swpout_vm_event(page);
343 set_page_writeback(page);
346 submit_bio_wait(&bio);
347 __end_swap_bio_write(&bio);
350 static void swap_writepage_bdev_async(struct page *page,
351 struct writeback_control *wbc, struct swap_info_struct *sis)
355 bio = bio_alloc(sis->bdev, 1,
356 REQ_OP_WRITE | REQ_SWAP | wbc_to_write_flags(wbc),
358 bio->bi_iter.bi_sector = swap_page_sector(page);
359 bio->bi_end_io = end_swap_bio_write;
360 __bio_add_page(bio, page, thp_size(page), 0);
362 bio_associate_blkg_from_page(bio, page);
363 count_swpout_vm_event(page);
364 set_page_writeback(page);
369 void __swap_writepage(struct page *page, struct writeback_control *wbc)
371 struct swap_info_struct *sis = page_swap_info(page);
373 VM_BUG_ON_PAGE(!PageSwapCache(page), page);
375 * ->flags can be updated non-atomicially (scan_swap_map_slots),
376 * but that will never affect SWP_FS_OPS, so the data_race
379 if (data_race(sis->flags & SWP_FS_OPS))
380 swap_writepage_fs(page, wbc);
381 else if (sis->flags & SWP_SYNCHRONOUS_IO)
382 swap_writepage_bdev_sync(page, wbc, sis);
384 swap_writepage_bdev_async(page, wbc, sis);
387 void swap_write_unplug(struct swap_iocb *sio)
389 struct iov_iter from;
390 struct address_space *mapping = sio->iocb.ki_filp->f_mapping;
393 iov_iter_bvec(&from, ITER_SOURCE, sio->bvec, sio->pages, sio->len);
394 ret = mapping->a_ops->swap_rw(&sio->iocb, &from);
395 if (ret != -EIOCBQUEUED)
396 sio_write_complete(&sio->iocb, ret);
399 static void sio_read_complete(struct kiocb *iocb, long ret)
401 struct swap_iocb *sio = container_of(iocb, struct swap_iocb, iocb);
404 if (ret == sio->len) {
405 for (p = 0; p < sio->pages; p++) {
406 struct page *page = sio->bvec[p].bv_page;
408 SetPageUptodate(page);
411 count_vm_events(PSWPIN, sio->pages);
413 for (p = 0; p < sio->pages; p++) {
414 struct page *page = sio->bvec[p].bv_page;
418 pr_alert_ratelimited("Read-error on swap-device\n");
420 mempool_free(sio, sio_pool);
423 static void swap_readpage_fs(struct page *page,
424 struct swap_iocb **plug)
426 struct swap_info_struct *sis = page_swap_info(page);
427 struct swap_iocb *sio = NULL;
428 loff_t pos = page_file_offset(page);
433 if (sio->iocb.ki_filp != sis->swap_file ||
434 sio->iocb.ki_pos + sio->len != pos) {
435 swap_read_unplug(sio);
440 sio = mempool_alloc(sio_pool, GFP_KERNEL);
441 init_sync_kiocb(&sio->iocb, sis->swap_file);
442 sio->iocb.ki_pos = pos;
443 sio->iocb.ki_complete = sio_read_complete;
447 bvec_set_page(&sio->bvec[sio->pages], page, thp_size(page), 0);
448 sio->len += thp_size(page);
450 if (sio->pages == ARRAY_SIZE(sio->bvec) || !plug) {
451 swap_read_unplug(sio);
458 static void swap_readpage_bdev_sync(struct page *page,
459 struct swap_info_struct *sis)
464 bio_init(&bio, sis->bdev, &bv, 1, REQ_OP_READ);
465 bio.bi_iter.bi_sector = swap_page_sector(page);
466 __bio_add_page(&bio, page, thp_size(page), 0);
468 * Keep this task valid during swap readpage because the oom killer may
469 * attempt to access it in the page fault retry time check.
471 get_task_struct(current);
472 count_vm_event(PSWPIN);
473 submit_bio_wait(&bio);
474 __end_swap_bio_read(&bio);
475 put_task_struct(current);
478 static void swap_readpage_bdev_async(struct page *page,
479 struct swap_info_struct *sis)
483 bio = bio_alloc(sis->bdev, 1, REQ_OP_READ, GFP_KERNEL);
484 bio->bi_iter.bi_sector = swap_page_sector(page);
485 bio->bi_end_io = end_swap_bio_read;
486 __bio_add_page(bio, page, thp_size(page), 0);
487 count_vm_event(PSWPIN);
491 void swap_readpage(struct page *page, bool synchronous, struct swap_iocb **plug)
493 struct swap_info_struct *sis = page_swap_info(page);
494 bool workingset = PageWorkingset(page);
495 unsigned long pflags;
498 VM_BUG_ON_PAGE(!PageSwapCache(page) && !synchronous, page);
499 VM_BUG_ON_PAGE(!PageLocked(page), page);
500 VM_BUG_ON_PAGE(PageUptodate(page), page);
503 * Count submission time as memory stall and delay. When the device
504 * is congested, or the submitting cgroup IO-throttled, submission
505 * can be a significant part of overall IO time.
508 delayacct_thrashing_start(&in_thrashing);
509 psi_memstall_enter(&pflags);
511 delayacct_swapin_start();
513 if (frontswap_load(page) == 0) {
514 SetPageUptodate(page);
516 } else if (data_race(sis->flags & SWP_FS_OPS)) {
517 swap_readpage_fs(page, plug);
518 } else if (synchronous || (sis->flags & SWP_SYNCHRONOUS_IO)) {
519 swap_readpage_bdev_sync(page, sis);
521 swap_readpage_bdev_async(page, sis);
525 delayacct_thrashing_end(&in_thrashing);
526 psi_memstall_leave(&pflags);
528 delayacct_swapin_end();
531 void __swap_read_unplug(struct swap_iocb *sio)
533 struct iov_iter from;
534 struct address_space *mapping = sio->iocb.ki_filp->f_mapping;
537 iov_iter_bvec(&from, ITER_DEST, sio->bvec, sio->pages, sio->len);
538 ret = mapping->a_ops->swap_rw(&sio->iocb, &from);
539 if (ret != -EIOCBQUEUED)
540 sio_read_complete(&sio->iocb, ret);