Skip to content

mm, swap: introduce swap table as swap cache (phase I)

Kairui Song linux-mm lkml 4 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest15 patches 28 repliesIn review 14 of 15 applied
  2. v315 patches 28 repliesSuperseded
  3. v215 patches 64 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v19 patches87 repliesSuperseded

Changes in v4 from the cover letter

- Patch 14: fix potential cluster leak when attemp a sleep allocation of swap table: Just remove the logic that check and return the percpu cluster, it was trying to avoid fragmentation, which wasn't very successfully and may not work at all if there are multiple devices. The fragmentation is not a serious issue and given the chance of hitting that race is extremely low, let's just ignore that [ Chris Meson ].
- Patch 8 & 9: move some changes from Patch 9 to Patch 8 to avoid build error, no code change. [ Baolin Wang ]
- Patch 9: Fix locking section issue, should protect the shmem statistic update with spin lock irq. Also fix an warn on condition.
Link to V3:
- https://lore.kernel.org/linux-mm/[email protected]/

Patches in v4 14 of 15 applied

#Subject and filesSizeRepliesApplied
1/15docs/mm: add document for swap tableDocumentation/mm/index.rst Documentation/mm/swap-table.rst MAINTAINERS+74 -017 replies
2/15mm, swap: use unified helper for swap cache look upmm/memory.c mm/mincore.c mm/shmem.c +4 more+81 -700 repliesApplied
3/15mm, swap: fix swap cache index error when retrying reclaimmm/swapfile.c+4 -40 repliesApplied
4/15mm, swap: check page poison flag after locking itmm/memory.c+11 -110 repliesApplied
5/15mm, swap: always lock and check the swap cache folio before usemm/memory.c mm/swap.h mm/swap_state.c +1 more+41 -61 replyApplied
6/15mm, swap: rename and move some swap cluster definition and helpersinclude/linux/swap.h mm/swap.h mm/swapfile.c+99 -1021 replyApplied
7/15mm, swap: tidy up swap device and cluster info helpersinclude/linux/swap.h mm/page_io.c mm/swap.h +2 more+60 -370 repliesApplied
8/15mm, swap: cleanup swap cache API and add kerneldocmm/filemap.c mm/memory-failure.c mm/memory.c +6 more+103 -590 repliesApplied
9/15mm/shmem, swap: remove redundant error handling for replacing foliomm/shmem.c+7 -251 replyApplied
10/15mm, swap: wrap swap cache replacement with a helpermm/huge_memory.c mm/migrate.c mm/shmem.c +2 more+44 -200 repliesApplied
11/15mm, swap: use the swap table for the swap cache and switch APIMAINTAINERS include/linux/swap.h mm/huge_memory.c +7 more+459 -2480 repliesApplied
12/15mm, swap: mark swap address space ro and add context debug checkmm/swap.h mm/swap_state.c+13 -20 repliesApplied
13/15mm, swap: remove contention workaround for swap cachemm/swap.h mm/swapfile.c mm/zswap.c+13 -300 repliesApplied
14/15mm, swap: implement dynamic allocation of swap tablemm/swap.h mm/swap_state.c mm/swap_table.h +1 more+194 -512 repliesApplied
15/15mm, swap: use a single page for swap table when the size fitsmm/swap_table.h mm/swapfile.c+43 -104 repliesApplied

Reviews trailers per patch

14 of 15 patches have a Reviewed-by or Acked-by.

PatchBaolin WangBarry SongDavid HildenbrandChris LiNhat Pham
1/15
2/15R-b R-b A-b A-b A-b
3/15R-b A-b A-b A-b
4/15A-b A-b A-b
5/15R-b A-b A-b A-b
6/15R-b R-b A-b A-b A-b
7/15R-b A-b A-b
8/15R-b R-b A-b A-b
9/15R-b R-b A-b
10/15R-b A-b A-b
11/15A-b
12/15A-b A-b
13/15R-b A-b A-b
14/15R-b A-b
15/15R-b A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 5 reviewers.

Read the v4 thread

Cover letter [PATCH v4 00/15] mm, swap: introduce swap table as swap cache (phase I)

From: Kairui Song <[email protected]>

This is the first phase of the bigger series implementing basic infrastructures for the Swap Table idea proposed at the LSF/MM/BPF topic "Integrate swap cache, swap maps with swap allocator" [1]. To give credit where it is due, this is based on Chris Li's idea and a prototype of using cluster size atomic arrays to implement swap cache.

This phase I contains 15 patches, introduces the swap table infrastructure and uses it as the swap cache backend. By doing so, we have up to ~5-20% performance gain in throughput, RPS or build time for benchmark and workload tests. The speed up is due to less contention on the swap cache access and shallower swap cache lookup path. The cluster size is much finer-grained than the 64M address space split, which is removed in this phase I. It also unifies and cleans up the swap code base.

Each swap cluster will dynamically allocate the swap table, which is an atomic array to cover every swap slot in the cluster. It replaces the swap cache backed by XArray. In phase I, the static allocated swap_map still co-exists with the swap table. The memory usage is about the same as the original on average. A few exception test cases show about 1% higher in memory usage. In the following phases of the series, swap_map will merge into the swap table without additional memory allocation. It will result in net memory reduction compared to the original swap cache.

Testing has shown that phase I has a significant performance improvement from 8c/1G ARM machine to 48c96t/128G x86_64 servers in many practical workloads.

The full picture with a summary can be found at [2]. An older bigger series of 28 patches is posted at [3].

vm-scability test:
==================
Test with:
usemem --init-time -O -y -x -n 31 1G (4G memcg, PMEM as swap)

                           Before:         After:
System time:               219.12s         158.16s        (-27.82%)
Sum Throughput:            4767.13 MB/s    6128.59 MB/s   (+28.55%)
Single process Throughput: 150.21 MB/s     196.52 MB/s    (+30.83%)
Free latency:              175047.58 us    131411.87 us   (-24.92%)

usemem --init-time -O -y -x -n 32 1536M (16G memory, global pressure, PMEM as swap)

                           Before:         After:
System time:               356.16s         284.68s      (-20.06%)
Sum Throughput:            4648.35 MB/s    5453.52 MB/s (+17.32%)
Single process Throughput: 141.63 MB/s     168.35 MB/s  (+18.86%)
Free latency:              499907.71 us    484977.03 us (-2.99%)

This shows an improvement of more than 20% improvement in most readings.

Build kernel test:
==================
The following result matrix is from building kernel with defconfig on tmpfs with ZSWAP / ZRAM, using different memory pressure and setups. Measuring sys and real time in seconds, less is better (user time is almost identical as expected):

-j<NR> / Mem | Sys before / after | Real before / after
Using 16G ZRAM with memcg limit:

     6  / 192M | 9686 / 9472  -2.21% | 2130  / 2096   -1.59%
     12 / 256M | 6610 / 6451  -2.41% |  827  /  812   -1.81%
     24 / 384M | 5938 / 5701  -3.37% |  414  /  405   -2.17%
     48 / 768M | 4696 / 4409  -6.11% |  188  /  182   -3.19%
With 64k folio:
     24 / 512M | 4222 / 4162  -1.42% |  326  /  321   -1.53%
     48 / 1G   | 3688 / 3622  -1.79% |  151  /  149   -1.32%
With ZSWAP with 3G memcg (using higher limit due to kmem account):
     48 / 3G   |  603 /  581  -3.65% |  81   /   80   -1.23%

Testing extremely high global memory and schedule pressure: Using ZSWAP with 32G NVMEs in a 48c VM that has 4G memory, no memcg limit, system components take up about 1.5G already, using make -j48 to build defconfig:

Before:  sys time: 2069.53s            real time: 135.76s
After:   sys time: 2021.13s (-2.34%)   real time: 134.23s (-1.12%)

On another 48c 4G memory VM, using 16G ZRAM as swap, testing make -j48 with same config:

Before:  sys time: 1756.96s            real time: 111.01s
After:   sys time: 1715.90s (-2.34%)   real time: 109.51s (-1.35%)

All cases are more or less faster, and no regression even under extremely heavy global memory pressure.

Redis / Valkey bench:
=====================
The test machine is a ARM64 VM with 1536M memory 12 cores, Redis is set to use 2500M memory, and ZRAM swap size is set to 5G:

Testing with:
redis-benchmark -r 2000000 -n 2000000 -d 1024 -c 12 -P 32 -t get

                no BGSAVE                with BGSAVE
Before:         487576.06 RPS            280016.02 RPS
After:          487541.76 RPS (-0.01%)   300155.32 RPS (+7.19%)

Testing with:
redis-benchmark -r 2500000 -n 2500000 -d 1024 -c 12 -P 32 -t get

                no BGSAVE                with BGSAVE
Before:         466789.59 RPS            281213.92 RPS
After:          466402.89 RPS (-0.08%)   298411.84 RPS (+6.12%)

With BGSAVE enabled, most Redis memory will have a swap count > 1 so swap cache is heavily in use. We can see a about 6% performance gain. No BGSAVE is very slightly slower (<0.1%) due to the higher memory pressure of the co-existence of swap_map and swap table. This will be optimzed into a net gain and up to 20% gain in BGSAVE case in the following phases.

HDD swap is also ~40% faster with usemem because we removed an old contention workaround.

---
V4 changes:
- Patch 14: fix potential cluster leak when attemp a sleep allocation of swap table: Just remove the logic that check and return the percpu cluster, it was trying to avoid fragmentation, which wasn't very successfully and may not work at all if there are multiple devices. The fragmentation is not a serious issue and given the chance of hitting that race is extremely low, let's just ignore that [ Chris Meson ].
- Patch 8 & 9: move some changes from Patch 9 to Patch 8 to avoid build error, no code change. [ Baolin Wang ]
- Patch 9: Fix locking section issue, should protect the shmem statistic update with spin lock irq. Also fix an warn on condition.
Link to V3:
- https://lore.kernel.org/linux-mm/[email protected]/

V3 changes:
There is basically no code change, mostly clean up and comment changes.
- Renames a few variable and functions [ David Hildenbrand, Chris Li ]
- Move the folio_matches_swap_entry check under unuse_pte in patch 5 [ David Hildenbrand ].
- Remove two redundant function params for the folio replace helper in patch 10, and add comment about folio setup [ David Hildenbrand ].
- Move the shmem clean up patch after the API rename patch to fix build error, no code change. [ Baolin Wang ]
- Fix build error with !SWAP and !SHMEM config. [ Klara Modin, SeongJae Park ]
- Fix a few typo and blank lines [ David Hildenbrand ]
- Minor code style change [ Chris Li ].
- Fix documentation warning from bot. [ Chris Li ]
Link to V2:
- https://lore.kernel.org/linux-mm/[email protected]/

V2 main updates:
- Added some more non-debug atomic sanity checks, which very slightly slow down the performance by a bit compared to V1 for some tests. But let's be more cautious in phase I, in case there is any hidden bug in swap, since it has a rather complex historical baggage. And phase I is a critical step for follow up swap table series [ Chris Li ]. These sanity checks can be removed very easily later or wrapped with a DEBUG_VM_SWAP as more swap table features land in.
- The code is basically same as V1, except one missing shmem statistic fixed thanks to [ Baolin Wang ]
- Added a lot of kernel docs, and more constify of sturct folio arguments, and better function names, thanks to [ David Hildenbrand ] and [ Chris Li ].
- Removed the arguable readahead change thanks to [ Chris Li ].
- Add an IRQ sanity check, have been testing with this check on for a long time but forgot to include it in V1.
Other updates:
- One VM_WARN_ON_ONCE to VM_WARN_ON_ONCE_FOLIO and minor adjust [ Barry Song ]
- Split out 4 patches from the old patches. The end result is still the same but should be easier to review [ Chris Li, David Hildenbrand ]
- Avoid some trivial blank line or variable name changes and comment fix [ Baoquan He, Chris Li, David Hildenbrand ]
- Added HDD test benchmark result [ Chris Li ]
- Rename and simplified folio_matches_swap_entry a little bit. Link to V1:
- https://lore.kernel.org/linux-mm/[email protected]/

Chris Li (1):
docs/mm: add document for swap table

Kairui Song (14):
mm, swap: use unified helper for swap cache look up
mm, swap: fix swap cache index error when retrying reclaim mm, swap: check page poison flag after locking it
mm, swap: always lock and check the swap cache folio before use mm, swap: rename and move some swap cluster definition and helpers mm, swap: tidy up swap device and cluster info helpers mm, swap: cleanup swap cache API and add kerneldoc mm/shmem, swap: remove redundant error handling for replacing folio mm, swap: wrap swap cache replacement with a helper
mm, swap: use the swap table for the swap cache and switch API mm, swap: mark swap address space ro and add context debug check mm, swap: remove contention workaround for swap cache mm, swap: implement dynamic allocation of swap table
mm, swap: use a single page for swap table when the size fits

 Documentation/mm/index.rst      |   1 +
 Documentation/mm/swap-table.rst |  72 +++++
 MAINTAINERS                     |   2 +
 include/linux/swap.h            |  42 ---
 mm/filemap.c                    |   2 +-
 mm/huge_memory.c                |  15 +-
 mm/memory-failure.c             |   2 +-
 mm/memory.c                     |  27 +-
 mm/migrate.c                    |  28 +-
 mm/mincore.c                    |   3 +-
 mm/page_io.c                    |  12 +-
 mm/shmem.c                      |  59 ++---
 mm/swap.h                       | 311 +++++++++++++++++++---
 mm/swap_state.c                 | 450 ++++++++++++++++---------------
 mm/swap_table.h                 | 130 +++++++++
 mm/swapfile.c                   | 451 +++++++++++++++++++++-----------
 mm/userfaultfd.c                |   5 +-
 mm/vmscan.c                     |  20 +-
 mm/zswap.c                      |   9 +-
 19 files changed, 1106 insertions(+), 535 deletions(-)
 create mode 100644 Documentation/mm/swap-table.rst
 create mode 100644 mm/swap_table.h
Signature · 1 line
2.51.0