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/blkdev.h>
23 #include <linux/psi.h>
24 #include <linux/uio.h>
25 #include <linux/sched/task.h>
26 #include <linux/delayacct.h>
27 #include <linux/zswap.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 folio *folio = bio_first_folio_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 folio_mark_uptodate(folio);
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;
169 pr_err("swapon: swapfile has holes\n");
174 static bool is_folio_zero_filled(struct folio *folio)
176 unsigned int pos, last_pos;
180 last_pos = PAGE_SIZE / sizeof(*data) - 1;
181 for (i = 0; i < folio_nr_pages(folio); i++) {
182 data = kmap_local_folio(folio, i * PAGE_SIZE);
184 * Check last word first, incase the page is zero-filled at
185 * the start and has non-zero data at the end, which is common
186 * in real-world workloads.
188 if (data[last_pos]) {
192 for (pos = 0; pos < last_pos; pos++) {
204 static void swap_zeromap_folio_set(struct folio *folio)
206 struct obj_cgroup *objcg = get_obj_cgroup_from_folio(folio);
207 struct swap_info_struct *sis = swp_swap_info(folio->swap);
208 int nr_pages = folio_nr_pages(folio);
212 for (i = 0; i < folio_nr_pages(folio); i++) {
213 entry = page_swap_entry(folio_page(folio, i));
214 set_bit(swp_offset(entry), sis->zeromap);
217 count_vm_events(SWPOUT_ZERO, nr_pages);
219 count_objcg_events(objcg, SWPOUT_ZERO, nr_pages);
220 obj_cgroup_put(objcg);
224 static void swap_zeromap_folio_clear(struct folio *folio)
226 struct swap_info_struct *sis = swp_swap_info(folio->swap);
230 for (i = 0; i < folio_nr_pages(folio); i++) {
231 entry = page_swap_entry(folio_page(folio, i));
232 clear_bit(swp_offset(entry), sis->zeromap);
237 * We may have stale swap cache pages in memory: notice
238 * them here and get rid of the unnecessary final write.
240 int swap_writeout(struct folio *folio, struct writeback_control *wbc)
244 if (folio_free_swap(folio)) {
249 * Arch code may have to preserve more data than just the page
250 * contents, e.g. memory tags.
252 ret = arch_prepare_to_swap(folio);
254 folio_mark_dirty(folio);
260 * Use a bitmap (zeromap) to avoid doing IO for zero-filled pages.
261 * The bits in zeromap are protected by the locked swapcache folio
262 * and atomic updates are used to protect against read-modify-write
263 * corruption due to other zero swap entries seeing concurrent updates.
265 if (is_folio_zero_filled(folio)) {
266 swap_zeromap_folio_set(folio);
271 * Clear bits this folio occupies in the zeromap to prevent
272 * zero data being read in from any previous zero writes that
273 * occupied the same swap entries.
275 swap_zeromap_folio_clear(folio);
277 if (zswap_store(folio)) {
278 count_mthp_stat(folio_order(folio), MTHP_STAT_ZSWPOUT);
282 if (!mem_cgroup_zswap_writeback_enabled(folio_memcg(folio))) {
283 folio_mark_dirty(folio);
284 return AOP_WRITEPAGE_ACTIVATE;
287 __swap_writepage(folio, wbc);
291 static inline void count_swpout_vm_event(struct folio *folio)
293 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
294 if (unlikely(folio_test_pmd_mappable(folio))) {
295 count_memcg_folio_events(folio, THP_SWPOUT, 1);
296 count_vm_event(THP_SWPOUT);
299 count_mthp_stat(folio_order(folio), MTHP_STAT_SWPOUT);
300 count_memcg_folio_events(folio, PSWPOUT, folio_nr_pages(folio));
301 count_vm_events(PSWPOUT, folio_nr_pages(folio));
304 #if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
305 static void bio_associate_blkg_from_page(struct bio *bio, struct folio *folio)
307 struct cgroup_subsys_state *css;
308 struct mem_cgroup *memcg;
310 memcg = folio_memcg(folio);
315 css = cgroup_e_css(memcg->css.cgroup, &io_cgrp_subsys);
316 bio_associate_blkg_from_css(bio, css);
320 #define bio_associate_blkg_from_page(bio, folio) do { } while (0)
321 #endif /* CONFIG_MEMCG && CONFIG_BLK_CGROUP */
325 struct bio_vec bvec[SWAP_CLUSTER_MAX];
329 static mempool_t *sio_pool;
331 int sio_pool_init(void)
334 mempool_t *pool = mempool_create_kmalloc_pool(
335 SWAP_CLUSTER_MAX, sizeof(struct swap_iocb));
336 if (cmpxchg(&sio_pool, NULL, pool))
337 mempool_destroy(pool);
344 static void sio_write_complete(struct kiocb *iocb, long ret)
346 struct swap_iocb *sio = container_of(iocb, struct swap_iocb, iocb);
347 struct page *page = sio->bvec[0].bv_page;
350 if (ret != sio->len) {
352 * In the case of swap-over-nfs, this can be a
353 * temporary failure if the system has limited
354 * memory for allocating transmit buffers.
355 * Mark the page dirty and avoid
356 * folio_rotate_reclaimable but rate-limit the
359 pr_err_ratelimited("Write error %ld on dio swapfile (%llu)\n",
360 ret, swap_dev_pos(page_swap_entry(page)));
361 for (p = 0; p < sio->pages; p++) {
362 page = sio->bvec[p].bv_page;
363 set_page_dirty(page);
364 ClearPageReclaim(page);
368 for (p = 0; p < sio->pages; p++)
369 end_page_writeback(sio->bvec[p].bv_page);
371 mempool_free(sio, sio_pool);
374 static void swap_writepage_fs(struct folio *folio, struct writeback_control *wbc)
376 struct swap_iocb *sio = NULL;
377 struct swap_info_struct *sis = swp_swap_info(folio->swap);
378 struct file *swap_file = sis->swap_file;
379 loff_t pos = swap_dev_pos(folio->swap);
381 count_swpout_vm_event(folio);
382 folio_start_writeback(folio);
385 sio = *wbc->swap_plug;
387 if (sio->iocb.ki_filp != swap_file ||
388 sio->iocb.ki_pos + sio->len != pos) {
389 swap_write_unplug(sio);
394 sio = mempool_alloc(sio_pool, GFP_NOIO);
395 init_sync_kiocb(&sio->iocb, swap_file);
396 sio->iocb.ki_complete = sio_write_complete;
397 sio->iocb.ki_pos = pos;
401 bvec_set_folio(&sio->bvec[sio->pages], folio, folio_size(folio), 0);
402 sio->len += folio_size(folio);
404 if (sio->pages == ARRAY_SIZE(sio->bvec) || !wbc->swap_plug) {
405 swap_write_unplug(sio);
409 *wbc->swap_plug = sio;
412 static void swap_writepage_bdev_sync(struct folio *folio,
413 struct writeback_control *wbc, struct swap_info_struct *sis)
418 bio_init(&bio, sis->bdev, &bv, 1,
419 REQ_OP_WRITE | REQ_SWAP | wbc_to_write_flags(wbc));
420 bio.bi_iter.bi_sector = swap_folio_sector(folio);
421 bio_add_folio_nofail(&bio, folio, folio_size(folio), 0);
423 bio_associate_blkg_from_page(&bio, folio);
424 count_swpout_vm_event(folio);
426 folio_start_writeback(folio);
429 submit_bio_wait(&bio);
430 __end_swap_bio_write(&bio);
433 static void swap_writepage_bdev_async(struct folio *folio,
434 struct writeback_control *wbc, struct swap_info_struct *sis)
438 bio = bio_alloc(sis->bdev, 1,
439 REQ_OP_WRITE | REQ_SWAP | wbc_to_write_flags(wbc),
441 bio->bi_iter.bi_sector = swap_folio_sector(folio);
442 bio->bi_end_io = end_swap_bio_write;
443 bio_add_folio_nofail(bio, folio, folio_size(folio), 0);
445 bio_associate_blkg_from_page(bio, folio);
446 count_swpout_vm_event(folio);
447 folio_start_writeback(folio);
452 void __swap_writepage(struct folio *folio, struct writeback_control *wbc)
454 struct swap_info_struct *sis = swp_swap_info(folio->swap);
456 VM_BUG_ON_FOLIO(!folio_test_swapcache(folio), folio);
458 * ->flags can be updated non-atomicially (scan_swap_map_slots),
459 * but that will never affect SWP_FS_OPS, so the data_race
462 if (data_race(sis->flags & SWP_FS_OPS))
463 swap_writepage_fs(folio, wbc);
465 * ->flags can be updated non-atomicially (scan_swap_map_slots),
466 * but that will never affect SWP_SYNCHRONOUS_IO, so the data_race
469 else if (data_race(sis->flags & SWP_SYNCHRONOUS_IO))
470 swap_writepage_bdev_sync(folio, wbc, sis);
472 swap_writepage_bdev_async(folio, wbc, sis);
475 void swap_write_unplug(struct swap_iocb *sio)
477 struct iov_iter from;
478 struct address_space *mapping = sio->iocb.ki_filp->f_mapping;
481 iov_iter_bvec(&from, ITER_SOURCE, sio->bvec, sio->pages, sio->len);
482 ret = mapping->a_ops->swap_rw(&sio->iocb, &from);
483 if (ret != -EIOCBQUEUED)
484 sio_write_complete(&sio->iocb, ret);
487 static void sio_read_complete(struct kiocb *iocb, long ret)
489 struct swap_iocb *sio = container_of(iocb, struct swap_iocb, iocb);
492 if (ret == sio->len) {
493 for (p = 0; p < sio->pages; p++) {
494 struct folio *folio = page_folio(sio->bvec[p].bv_page);
496 count_mthp_stat(folio_order(folio), MTHP_STAT_SWPIN);
497 count_memcg_folio_events(folio, PSWPIN, folio_nr_pages(folio));
498 folio_mark_uptodate(folio);
501 count_vm_events(PSWPIN, sio->pages);
503 for (p = 0; p < sio->pages; p++) {
504 struct folio *folio = page_folio(sio->bvec[p].bv_page);
508 pr_alert_ratelimited("Read-error on swap-device\n");
510 mempool_free(sio, sio_pool);
513 static bool swap_read_folio_zeromap(struct folio *folio)
515 int nr_pages = folio_nr_pages(folio);
516 struct obj_cgroup *objcg;
520 * Swapping in a large folio that is partially in the zeromap is not
521 * currently handled. Return true without marking the folio uptodate so
522 * that an IO error is emitted (e.g. do_swap_page() will sigbus).
524 if (WARN_ON_ONCE(swap_zeromap_batch(folio->swap, nr_pages,
525 &is_zeromap) != nr_pages))
531 objcg = get_obj_cgroup_from_folio(folio);
532 count_vm_events(SWPIN_ZERO, nr_pages);
534 count_objcg_events(objcg, SWPIN_ZERO, nr_pages);
535 obj_cgroup_put(objcg);
538 folio_zero_range(folio, 0, folio_size(folio));
539 folio_mark_uptodate(folio);
543 static void swap_read_folio_fs(struct folio *folio, struct swap_iocb **plug)
545 struct swap_info_struct *sis = swp_swap_info(folio->swap);
546 struct swap_iocb *sio = NULL;
547 loff_t pos = swap_dev_pos(folio->swap);
552 if (sio->iocb.ki_filp != sis->swap_file ||
553 sio->iocb.ki_pos + sio->len != pos) {
554 swap_read_unplug(sio);
559 sio = mempool_alloc(sio_pool, GFP_KERNEL);
560 init_sync_kiocb(&sio->iocb, sis->swap_file);
561 sio->iocb.ki_pos = pos;
562 sio->iocb.ki_complete = sio_read_complete;
566 bvec_set_folio(&sio->bvec[sio->pages], folio, folio_size(folio), 0);
567 sio->len += folio_size(folio);
569 if (sio->pages == ARRAY_SIZE(sio->bvec) || !plug) {
570 swap_read_unplug(sio);
577 static void swap_read_folio_bdev_sync(struct folio *folio,
578 struct swap_info_struct *sis)
583 bio_init(&bio, sis->bdev, &bv, 1, REQ_OP_READ);
584 bio.bi_iter.bi_sector = swap_folio_sector(folio);
585 bio_add_folio_nofail(&bio, folio, folio_size(folio), 0);
587 * Keep this task valid during swap readpage because the oom killer may
588 * attempt to access it in the page fault retry time check.
590 get_task_struct(current);
591 count_mthp_stat(folio_order(folio), MTHP_STAT_SWPIN);
592 count_memcg_folio_events(folio, PSWPIN, folio_nr_pages(folio));
593 count_vm_events(PSWPIN, folio_nr_pages(folio));
594 submit_bio_wait(&bio);
595 __end_swap_bio_read(&bio);
596 put_task_struct(current);
599 static void swap_read_folio_bdev_async(struct folio *folio,
600 struct swap_info_struct *sis)
604 bio = bio_alloc(sis->bdev, 1, REQ_OP_READ, GFP_KERNEL);
605 bio->bi_iter.bi_sector = swap_folio_sector(folio);
606 bio->bi_end_io = end_swap_bio_read;
607 bio_add_folio_nofail(bio, folio, folio_size(folio), 0);
608 count_mthp_stat(folio_order(folio), MTHP_STAT_SWPIN);
609 count_memcg_folio_events(folio, PSWPIN, folio_nr_pages(folio));
610 count_vm_events(PSWPIN, folio_nr_pages(folio));
614 void swap_read_folio(struct folio *folio, struct swap_iocb **plug)
616 struct swap_info_struct *sis = swp_swap_info(folio->swap);
617 bool synchronous = sis->flags & SWP_SYNCHRONOUS_IO;
618 bool workingset = folio_test_workingset(folio);
619 unsigned long pflags;
622 VM_BUG_ON_FOLIO(!folio_test_swapcache(folio) && !synchronous, folio);
623 VM_BUG_ON_FOLIO(!folio_test_locked(folio), folio);
624 VM_BUG_ON_FOLIO(folio_test_uptodate(folio), folio);
627 * Count submission time as memory stall and delay. When the device
628 * is congested, or the submitting cgroup IO-throttled, submission
629 * can be a significant part of overall IO time.
632 delayacct_thrashing_start(&in_thrashing);
633 psi_memstall_enter(&pflags);
635 delayacct_swapin_start();
637 if (swap_read_folio_zeromap(folio)) {
642 if (zswap_load(folio) != -ENOENT)
645 /* We have to read from slower devices. Increase zswap protection. */
646 zswap_folio_swapin(folio);
648 if (data_race(sis->flags & SWP_FS_OPS)) {
649 swap_read_folio_fs(folio, plug);
650 } else if (synchronous) {
651 swap_read_folio_bdev_sync(folio, sis);
653 swap_read_folio_bdev_async(folio, sis);
658 delayacct_thrashing_end(&in_thrashing);
659 psi_memstall_leave(&pflags);
661 delayacct_swapin_end();
664 void __swap_read_unplug(struct swap_iocb *sio)
666 struct iov_iter from;
667 struct address_space *mapping = sio->iocb.ki_filp->f_mapping;
670 iov_iter_bvec(&from, ITER_DEST, sio->bvec, sio->pages, sio->len);
671 ret = mapping->a_ops->swap_rw(&sio->iocb, &from);
672 if (ret != -EIOCBQUEUED)
673 sio_read_complete(&sio->iocb, ret);