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 page *page = bio_first_page_all(bio);
37 * We failed to write the page out to swap-space.
38 * Re-dirty the page in order to avoid it being reclaimed.
39 * Also print a dire warning that things will go BAD (tm)
42 * Also clear PG_reclaim to avoid folio_rotate_reclaimable()
45 pr_alert_ratelimited("Write-error on swap-device (%u:%u:%llu)\n",
46 MAJOR(bio_dev(bio)), MINOR(bio_dev(bio)),
47 (unsigned long long)bio->bi_iter.bi_sector);
48 ClearPageReclaim(page);
50 end_page_writeback(page);
54 static void end_swap_bio_read(struct bio *bio)
56 struct page *page = bio_first_page_all(bio);
57 struct task_struct *waiter = bio->bi_private;
61 ClearPageUptodate(page);
62 pr_alert_ratelimited("Read-error on swap-device (%u:%u:%llu)\n",
63 MAJOR(bio_dev(bio)), MINOR(bio_dev(bio)),
64 (unsigned long long)bio->bi_iter.bi_sector);
68 SetPageUptodate(page);
71 WRITE_ONCE(bio->bi_private, NULL);
74 blk_wake_io_task(waiter);
75 put_task_struct(waiter);
79 int generic_swapfile_activate(struct swap_info_struct *sis,
80 struct file *swap_file,
83 struct address_space *mapping = swap_file->f_mapping;
84 struct inode *inode = mapping->host;
85 unsigned blocks_per_page;
86 unsigned long page_no;
90 sector_t lowest_block = -1;
91 sector_t highest_block = 0;
95 blkbits = inode->i_blkbits;
96 blocks_per_page = PAGE_SIZE >> blkbits;
99 * Map all the blocks into the extent tree. This code doesn't try
104 last_block = i_size_read(inode) >> blkbits;
105 while ((probe_block + blocks_per_page) <= last_block &&
106 page_no < sis->max) {
107 unsigned block_in_page;
108 sector_t first_block;
112 first_block = probe_block;
113 ret = bmap(inode, &first_block);
114 if (ret || !first_block)
118 * It must be PAGE_SIZE aligned on-disk
120 if (first_block & (blocks_per_page - 1)) {
125 for (block_in_page = 1; block_in_page < blocks_per_page;
129 block = probe_block + block_in_page;
130 ret = bmap(inode, &block);
134 if (block != first_block + block_in_page) {
141 first_block >>= (PAGE_SHIFT - blkbits);
142 if (page_no) { /* exclude the header page */
143 if (first_block < lowest_block)
144 lowest_block = first_block;
145 if (first_block > highest_block)
146 highest_block = first_block;
150 * We found a PAGE_SIZE-length, PAGE_SIZE-aligned run of blocks
152 ret = add_swap_extent(sis, page_no, 1, first_block);
157 probe_block += blocks_per_page;
162 *span = 1 + highest_block - lowest_block;
164 page_no = 1; /* force Empty message */
166 sis->pages = page_no - 1;
167 sis->highest_bit = page_no - 1;
171 pr_err("swapon: swapfile has holes\n");
177 * We may have stale swap cache pages in memory: notice
178 * them here and get rid of the unnecessary final write.
180 int swap_writepage(struct page *page, struct writeback_control *wbc)
182 struct folio *folio = page_folio(page);
185 if (folio_free_swap(folio)) {
190 * Arch code may have to preserve more data than just the page
191 * contents, e.g. memory tags.
193 ret = arch_prepare_to_swap(&folio->page);
195 folio_mark_dirty(folio);
199 if (frontswap_store(&folio->page) == 0) {
200 folio_start_writeback(folio);
202 folio_end_writeback(folio);
205 ret = __swap_writepage(&folio->page, wbc);
210 static inline void count_swpout_vm_event(struct page *page)
212 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
213 if (unlikely(PageTransHuge(page)))
214 count_vm_event(THP_SWPOUT);
216 count_vm_events(PSWPOUT, thp_nr_pages(page));
219 #if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
220 static void bio_associate_blkg_from_page(struct bio *bio, struct page *page)
222 struct cgroup_subsys_state *css;
223 struct mem_cgroup *memcg;
225 memcg = page_memcg(page);
230 css = cgroup_e_css(memcg->css.cgroup, &io_cgrp_subsys);
231 bio_associate_blkg_from_css(bio, css);
235 #define bio_associate_blkg_from_page(bio, page) do { } while (0)
236 #endif /* CONFIG_MEMCG && CONFIG_BLK_CGROUP */
240 struct bio_vec bvec[SWAP_CLUSTER_MAX];
244 static mempool_t *sio_pool;
246 int sio_pool_init(void)
249 mempool_t *pool = mempool_create_kmalloc_pool(
250 SWAP_CLUSTER_MAX, sizeof(struct swap_iocb));
251 if (cmpxchg(&sio_pool, NULL, pool))
252 mempool_destroy(pool);
259 static void sio_write_complete(struct kiocb *iocb, long ret)
261 struct swap_iocb *sio = container_of(iocb, struct swap_iocb, iocb);
262 struct page *page = sio->bvec[0].bv_page;
265 if (ret != sio->len) {
267 * In the case of swap-over-nfs, this can be a
268 * temporary failure if the system has limited
269 * memory for allocating transmit buffers.
270 * Mark the page dirty and avoid
271 * folio_rotate_reclaimable but rate-limit the
272 * messages but do not flag PageError like
273 * the normal direct-to-bio case as it could
276 pr_err_ratelimited("Write error %ld on dio swapfile (%llu)\n",
277 ret, page_file_offset(page));
278 for (p = 0; p < sio->pages; p++) {
279 page = sio->bvec[p].bv_page;
280 set_page_dirty(page);
281 ClearPageReclaim(page);
284 for (p = 0; p < sio->pages; p++)
285 count_swpout_vm_event(sio->bvec[p].bv_page);
288 for (p = 0; p < sio->pages; p++)
289 end_page_writeback(sio->bvec[p].bv_page);
291 mempool_free(sio, sio_pool);
294 static int swap_writepage_fs(struct page *page, struct writeback_control *wbc)
296 struct swap_iocb *sio = NULL;
297 struct swap_info_struct *sis = page_swap_info(page);
298 struct file *swap_file = sis->swap_file;
299 loff_t pos = page_file_offset(page);
301 set_page_writeback(page);
304 sio = *wbc->swap_plug;
306 if (sio->iocb.ki_filp != swap_file ||
307 sio->iocb.ki_pos + sio->len != pos) {
308 swap_write_unplug(sio);
313 sio = mempool_alloc(sio_pool, GFP_NOIO);
314 init_sync_kiocb(&sio->iocb, swap_file);
315 sio->iocb.ki_complete = sio_write_complete;
316 sio->iocb.ki_pos = pos;
320 sio->bvec[sio->pages].bv_page = page;
321 sio->bvec[sio->pages].bv_len = thp_size(page);
322 sio->bvec[sio->pages].bv_offset = 0;
323 sio->len += thp_size(page);
325 if (sio->pages == ARRAY_SIZE(sio->bvec) || !wbc->swap_plug) {
326 swap_write_unplug(sio);
330 *wbc->swap_plug = sio;
335 int __swap_writepage(struct page *page, struct writeback_control *wbc)
339 struct swap_info_struct *sis = page_swap_info(page);
341 VM_BUG_ON_PAGE(!PageSwapCache(page), page);
343 * ->flags can be updated non-atomicially (scan_swap_map_slots),
344 * but that will never affect SWP_FS_OPS, so the data_race
347 if (data_race(sis->flags & SWP_FS_OPS))
348 return swap_writepage_fs(page, wbc);
350 ret = bdev_write_page(sis->bdev, swap_page_sector(page), page, wbc);
352 count_swpout_vm_event(page);
356 bio = bio_alloc(sis->bdev, 1,
357 REQ_OP_WRITE | REQ_SWAP | wbc_to_write_flags(wbc),
359 bio->bi_iter.bi_sector = swap_page_sector(page);
360 bio->bi_end_io = end_swap_bio_write;
361 bio_add_page(bio, page, thp_size(page), 0);
363 bio_associate_blkg_from_page(bio, page);
364 count_swpout_vm_event(page);
365 set_page_writeback(page);
372 void swap_write_unplug(struct swap_iocb *sio)
374 struct iov_iter from;
375 struct address_space *mapping = sio->iocb.ki_filp->f_mapping;
378 iov_iter_bvec(&from, ITER_SOURCE, sio->bvec, sio->pages, sio->len);
379 ret = mapping->a_ops->swap_rw(&sio->iocb, &from);
380 if (ret != -EIOCBQUEUED)
381 sio_write_complete(&sio->iocb, ret);
384 static void sio_read_complete(struct kiocb *iocb, long ret)
386 struct swap_iocb *sio = container_of(iocb, struct swap_iocb, iocb);
389 if (ret == sio->len) {
390 for (p = 0; p < sio->pages; p++) {
391 struct page *page = sio->bvec[p].bv_page;
393 SetPageUptodate(page);
396 count_vm_events(PSWPIN, sio->pages);
398 for (p = 0; p < sio->pages; p++) {
399 struct page *page = sio->bvec[p].bv_page;
402 ClearPageUptodate(page);
405 pr_alert_ratelimited("Read-error on swap-device\n");
407 mempool_free(sio, sio_pool);
410 static void swap_readpage_fs(struct page *page,
411 struct swap_iocb **plug)
413 struct swap_info_struct *sis = page_swap_info(page);
414 struct swap_iocb *sio = NULL;
415 loff_t pos = page_file_offset(page);
420 if (sio->iocb.ki_filp != sis->swap_file ||
421 sio->iocb.ki_pos + sio->len != pos) {
422 swap_read_unplug(sio);
427 sio = mempool_alloc(sio_pool, GFP_KERNEL);
428 init_sync_kiocb(&sio->iocb, sis->swap_file);
429 sio->iocb.ki_pos = pos;
430 sio->iocb.ki_complete = sio_read_complete;
434 sio->bvec[sio->pages].bv_page = page;
435 sio->bvec[sio->pages].bv_len = thp_size(page);
436 sio->bvec[sio->pages].bv_offset = 0;
437 sio->len += thp_size(page);
439 if (sio->pages == ARRAY_SIZE(sio->bvec) || !plug) {
440 swap_read_unplug(sio);
447 int swap_readpage(struct page *page, bool synchronous,
448 struct swap_iocb **plug)
452 struct swap_info_struct *sis = page_swap_info(page);
453 bool workingset = PageWorkingset(page);
454 unsigned long pflags;
457 VM_BUG_ON_PAGE(!PageSwapCache(page) && !synchronous, page);
458 VM_BUG_ON_PAGE(!PageLocked(page), page);
459 VM_BUG_ON_PAGE(PageUptodate(page), page);
462 * Count submission time as memory stall and delay. When the device
463 * is congested, or the submitting cgroup IO-throttled, submission
464 * can be a significant part of overall IO time.
467 delayacct_thrashing_start(&in_thrashing);
468 psi_memstall_enter(&pflags);
470 delayacct_swapin_start();
472 if (frontswap_load(page) == 0) {
473 SetPageUptodate(page);
478 if (data_race(sis->flags & SWP_FS_OPS)) {
479 swap_readpage_fs(page, plug);
483 if (sis->flags & SWP_SYNCHRONOUS_IO) {
484 ret = bdev_read_page(sis->bdev, swap_page_sector(page), page);
486 count_vm_event(PSWPIN);
492 bio = bio_alloc(sis->bdev, 1, REQ_OP_READ, GFP_KERNEL);
493 bio->bi_iter.bi_sector = swap_page_sector(page);
494 bio->bi_end_io = end_swap_bio_read;
495 bio_add_page(bio, page, thp_size(page), 0);
497 * Keep this task valid during swap readpage because the oom killer may
498 * attempt to access it in the page fault retry time check.
501 get_task_struct(current);
502 bio->bi_private = current;
504 count_vm_event(PSWPIN);
507 while (synchronous) {
508 set_current_state(TASK_UNINTERRUPTIBLE);
509 if (!READ_ONCE(bio->bi_private))
514 __set_current_state(TASK_RUNNING);
519 delayacct_thrashing_end(&in_thrashing);
520 psi_memstall_leave(&pflags);
522 delayacct_swapin_end();
526 void __swap_read_unplug(struct swap_iocb *sio)
528 struct iov_iter from;
529 struct address_space *mapping = sio->iocb.ki_filp->f_mapping;
532 iov_iter_bvec(&from, ITER_DEST, sio->bvec, sio->pages, sio->len);
533 ret = mapping->a_ops->swap_rw(&sio->iocb, &from);
534 if (ret != -EIOCBQUEUED)
535 sio_read_complete(&sio->iocb, ret);