Documentation/vm/vmemmap_dedup.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 =========================================
   4 A vmemmap diet for HugeTLB and Device DAX
   5 =========================================
   6
   7 HugeTLB
   8 =======
   9
  10 The struct page structures (page structs) are used to describe a physical
  11 page frame. By default, there is a one-to-one mapping from a page frame to
  12 it's corresponding page struct.
  13
  14 HugeTLB pages consist of multiple base page size pages and is supported by many
  15 architectures. See Documentation/admin-guide/mm/hugetlbpage.rst for more
  16 details. On the x86-64 architecture, HugeTLB pages of size 2MB and 1GB are
  17 currently supported. Since the base page size on x86 is 4KB, a 2MB HugeTLB page
  18 consists of 512 base pages and a 1GB HugeTLB page consists of 4096 base pages.
  19 For each base page, there is a corresponding page struct.
  20
  21 Within the HugeTLB subsystem, only the first 4 page structs are used to
  22 contain unique information about a HugeTLB page. __NR_USED_SUBPAGE provides
  23 this upper limit. The only 'useful' information in the remaining page structs
  24 is the compound_head field, and this field is the same for all tail pages.
  25
  26 By removing redundant page structs for HugeTLB pages, memory can be returned
  27 to the buddy allocator for other uses.
  28
  29 Different architectures support different HugeTLB pages. For example, the
  30 following table is the HugeTLB page size supported by x86 and arm64
  31 architectures. Because arm64 supports 4k, 16k, and 64k base pages and
  32 supports contiguous entries, so it supports many kinds of sizes of HugeTLB
  33 page.
  34
  35 +--------------+-----------+-----------------------------------------------+
  36 | Architecture | Page Size |                HugeTLB Page Size              |
  37 +--------------+-----------+-----------+-----------+-----------+-----------+
  38 |    x86-64    |    4KB    |    2MB    |    1GB    |           |           |
  39 +--------------+-----------+-----------+-----------+-----------+-----------+
  40 |              |    4KB    |   64KB    |    2MB    |    32MB   |    1GB    |
  41 |              +-----------+-----------+-----------+-----------+-----------+
  42 |    arm64     |   16KB    |    2MB    |   32MB    |     1GB   |           |
  43 |              +-----------+-----------+-----------+-----------+-----------+
  44 |              |   64KB    |    2MB    |  512MB    |    16GB   |           |
  45 +--------------+-----------+-----------+-----------+-----------+-----------+
  46
  47 When the system boot up, every HugeTLB page has more than one struct page
  48 structs which size is (unit: pages)::
  49
  50    struct_size = HugeTLB_Size / PAGE_SIZE * sizeof(struct page) / PAGE_SIZE
  51
  52 Where HugeTLB_Size is the size of the HugeTLB page. We know that the size
  53 of the HugeTLB page is always n times PAGE_SIZE. So we can get the following
  54 relationship::
  55
  56    HugeTLB_Size = n * PAGE_SIZE
  57
  58 Then::
  59
  60    struct_size = n * PAGE_SIZE / PAGE_SIZE * sizeof(struct page) / PAGE_SIZE
  61                = n * sizeof(struct page) / PAGE_SIZE
  62
  63 We can use huge mapping at the pud/pmd level for the HugeTLB page.
  64
  65 For the HugeTLB page of the pmd level mapping, then::
  66
  67    struct_size = n * sizeof(struct page) / PAGE_SIZE
  68                = PAGE_SIZE / sizeof(pte_t) * sizeof(struct page) / PAGE_SIZE
  69                = sizeof(struct page) / sizeof(pte_t)
  70                = 64 / 8
  71                = 8 (pages)
  72
  73 Where n is how many pte entries which one page can contains. So the value of
  74 n is (PAGE_SIZE / sizeof(pte_t)).
  75
  76 This optimization only supports 64-bit system, so the value of sizeof(pte_t)
  77 is 8. And this optimization also applicable only when the size of struct page
  78 is a power of two. In most cases, the size of struct page is 64 bytes (e.g.
  79 x86-64 and arm64). So if we use pmd level mapping for a HugeTLB page, the
  80 size of struct page structs of it is 8 page frames which size depends on the
  81 size of the base page.
  82
  83 For the HugeTLB page of the pud level mapping, then::
  84
  85    struct_size = PAGE_SIZE / sizeof(pmd_t) * struct_size(pmd)
  86                = PAGE_SIZE / 8 * 8 (pages)
  87                = PAGE_SIZE (pages)
  88
  89 Where the struct_size(pmd) is the size of the struct page structs of a
  90 HugeTLB page of the pmd level mapping.
  91
  92 E.g.: A 2MB HugeTLB page on x86_64 consists in 8 page frames while 1GB
  93 HugeTLB page consists in 4096.
  94
  95 Next, we take the pmd level mapping of the HugeTLB page as an example to
  96 show the internal implementation of this optimization. There are 8 pages
  97 struct page structs associated with a HugeTLB page which is pmd mapped.
  98
  99 Here is how things look before optimization::
 100
 101     HugeTLB                  struct pages(8 pages)         page frame(8 pages)
 102  +-----------+ ---virt_to_page---> +-----------+   mapping to   +-----------+
 103  |           |                     |     0     | -------------> |     0     |
 104  |           |                     +-----------+                +-----------+
 105  |           |                     |     1     | -------------> |     1     |
 106  |           |                     +-----------+                +-----------+
 107  |           |                     |     2     | -------------> |     2     |
 108  |           |                     +-----------+                +-----------+
 109  |           |                     |     3     | -------------> |     3     |
 110  |           |                     +-----------+                +-----------+
 111  |           |                     |     4     | -------------> |     4     |
 112  |    PMD    |                     +-----------+                +-----------+
 113  |   level   |                     |     5     | -------------> |     5     |
 114  |  mapping  |                     +-----------+                +-----------+
 115  |           |                     |     6     | -------------> |     6     |
 116  |           |                     +-----------+                +-----------+
 117  |           |                     |     7     | -------------> |     7     |
 118  |           |                     +-----------+                +-----------+
 119  |           |
 120  |           |
 121  |           |
 122  +-----------+
 123
 124 The value of page->compound_head is the same for all tail pages. The first
 125 page of page structs (page 0) associated with the HugeTLB page contains the 4
 126 page structs necessary to describe the HugeTLB. The only use of the remaining
 127 pages of page structs (page 1 to page 7) is to point to page->compound_head.
 128 Therefore, we can remap pages 1 to 7 to page 0. Only 1 page of page structs
 129 will be used for each HugeTLB page. This will allow us to free the remaining
 130 7 pages to the buddy allocator.
 131
 132 Here is how things look after remapping::
 133
 134     HugeTLB                  struct pages(8 pages)         page frame(8 pages)
 135  +-----------+ ---virt_to_page---> +-----------+   mapping to   +-----------+
 136  |           |                     |     0     | -------------> |     0     |
 137  |           |                     +-----------+                +-----------+
 138  |           |                     |     1     | ---------------^ ^ ^ ^ ^ ^ ^
 139  |           |                     +-----------+                  | | | | | |
 140  |           |                     |     2     | -----------------+ | | | | |
 141  |           |                     +-----------+                    | | | | |
 142  |           |                     |     3     | -------------------+ | | | |
 143  |           |                     +-----------+                      | | | |
 144  |           |                     |     4     | ---------------------+ | | |
 145  |    PMD    |                     +-----------+                        | | |
 146  |   level   |                     |     5     | -----------------------+ | |
 147  |  mapping  |                     +-----------+                          | |
 148  |           |                     |     6     | -------------------------+ |
 149  |           |                     +-----------+                            |
 150  |           |                     |     7     | ---------------------------+
 151  |           |                     +-----------+
 152  |           |
 153  |           |
 154  |           |
 155  +-----------+
 156
 157 When a HugeTLB is freed to the buddy system, we should allocate 7 pages for
 158 vmemmap pages and restore the previous mapping relationship.
 159
 160 For the HugeTLB page of the pud level mapping. It is similar to the former.
 161 We also can use this approach to free (PAGE_SIZE - 1) vmemmap pages.
 162
 163 Apart from the HugeTLB page of the pmd/pud level mapping, some architectures
 164 (e.g. aarch64) provides a contiguous bit in the translation table entries
 165 that hints to the MMU to indicate that it is one of a contiguous set of
 166 entries that can be cached in a single TLB entry.
 167
 168 The contiguous bit is used to increase the mapping size at the pmd and pte
 169 (last) level. So this type of HugeTLB page can be optimized only when its
 170 size of the struct page structs is greater than 1 page.
 171
 172 Notice: The head vmemmap page is not freed to the buddy allocator and all
 173 tail vmemmap pages are mapped to the head vmemmap page frame. So we can see
 174 more than one struct page struct with PG_head (e.g. 8 per 2 MB HugeTLB page)
 175 associated with each HugeTLB page. The compound_head() can handle this
 176 correctly (more details refer to the comment above compound_head()).
 177
 178 Device DAX
 179 ==========
 180
 181 The device-dax interface uses the same tail deduplication technique explained
 182 in the previous chapter, except when used with the vmemmap in
 183 the device (altmap).
 184
 185 The following page sizes are supported in DAX: PAGE_SIZE (4K on x86_64),
 186 PMD_SIZE (2M on x86_64) and PUD_SIZE (1G on x86_64).
 187
 188 The differences with HugeTLB are relatively minor.
 189
 190 It only use 3 page structs for storing all information as opposed
 191 to 4 on HugeTLB pages.
 192
 193 There's no remapping of vmemmap given that device-dax memory is not part of
 194 System RAM ranges initialized at boot. Thus the tail page deduplication
 195 happens at a later stage when we populate the sections. HugeTLB reuses the
 196 the head vmemmap page representing, whereas device-dax reuses the tail
 197 vmemmap page. This results in only half of the savings compared to HugeTLB.
 198
 199 Deduplicated tail pages are not mapped read-only.
 200
 201 Here's how things look like on device-dax after the sections are populated::
 202
 203  +-----------+ ---virt_to_page---> +-----------+   mapping to   +-----------+
 204  |           |                     |     0     | -------------> |     0     |
 205  |           |                     +-----------+                +-----------+
 206  |           |                     |     1     | -------------> |     1     |
 207  |           |                     +-----------+                +-----------+
 208  |           |                     |     2     | ----------------^ ^ ^ ^ ^ ^
 209  |           |                     +-----------+                   | | | | |
 210  |           |                     |     3     | ------------------+ | | | |
 211  |           |                     +-----------+                     | | | |
 212  |           |                     |     4     | --------------------+ | | |
 213  |    PMD    |                     +-----------+                       | | |
 214  |   level   |                     |     5     | ----------------------+ | |
 215  |  mapping  |                     +-----------+                         | |
 216  |           |                     |     6     | ------------------------+ |
 217  |           |                     +-----------+                           |
 218  |           |                     |     7     | --------------------------+
 219  |           |                     +-----------+
 220  |           |
 221  |           |
 222  |           |
 223  +-----------+