Documentation/vm/pagemap.txt

   1 pagemap, from the userspace perspective
   2 ---------------------------------------
   3
   4 pagemap is a new (as of 2.6.25) set of interfaces in the kernel that allow
   5 userspace programs to examine the page tables and related information by
   6 reading files in /proc.
   7
   8 There are three components to pagemap:
   9
  10  * /proc/pid/pagemap.  This file lets a userspace process find out which
  11    physical frame each virtual page is mapped to.  It contains one 64-bit
  12    value for each virtual page, containing the following data (from
  13    fs/proc/task_mmu.c, above pagemap_read):
  14
  15     * Bits 0-54  page frame number (PFN) if present
  16     * Bits 0-4   swap type if swapped
  17     * Bits 5-54  swap offset if swapped
  18     * Bit  55    pte is soft-dirty (see Documentation/vm/soft-dirty.txt)
  19     * Bit  56    page exclusively mapped (since 4.2)
  20     * Bits 57-60 zero
  21     * Bit  61    page is file-page or shared-anon (since 3.5)
  22     * Bit  62    page swapped
  23     * Bit  63    page present
  24
  25    Since Linux 4.0 only users with the CAP_SYS_ADMIN capability can get PFNs.
  26    In 4.0 and 4.1 opens by unprivileged fail with -EPERM.  Starting from
  27    4.2 the PFN field is zeroed if the user does not have CAP_SYS_ADMIN.
  28    Reason: information about PFNs helps in exploiting Rowhammer vulnerability.
  29
  30    If the page is not present but in swap, then the PFN contains an
  31    encoding of the swap file number and the page's offset into the
  32    swap. Unmapped pages return a null PFN. This allows determining
  33    precisely which pages are mapped (or in swap) and comparing mapped
  34    pages between processes.
  35
  36    Efficient users of this interface will use /proc/pid/maps to
  37    determine which areas of memory are actually mapped and llseek to
  38    skip over unmapped regions.
  39
  40  * /proc/kpagecount.  This file contains a 64-bit count of the number of
  41    times each page is mapped, indexed by PFN.
  42
  43  * /proc/kpageflags.  This file contains a 64-bit set of flags for each
  44    page, indexed by PFN.
  45
  46    The flags are (from fs/proc/page.c, above kpageflags_read):
  47
  48      0. LOCKED
  49      1. ERROR
  50      2. REFERENCED
  51      3. UPTODATE
  52      4. DIRTY
  53      5. LRU
  54      6. ACTIVE
  55      7. SLAB
  56      8. WRITEBACK
  57      9. RECLAIM
  58     10. BUDDY
  59     11. MMAP
  60     12. ANON
  61     13. SWAPCACHE
  62     14. SWAPBACKED
  63     15. COMPOUND_HEAD
  64     16. COMPOUND_TAIL
  65     16. HUGE
  66     18. UNEVICTABLE
  67     19. HWPOISON
  68     20. NOPAGE
  69     21. KSM
  70     22. THP
  71     23. BALLOON
  72     24. ZERO_PAGE
  73
  74 Short descriptions to the page flags:
  75
  76  0. LOCKED
  77     page is being locked for exclusive access, eg. by undergoing read/write IO
  78
  79  7. SLAB
  80     page is managed by the SLAB/SLOB/SLUB/SLQB kernel memory allocator
  81     When compound page is used, SLUB/SLQB will only set this flag on the head
  82     page; SLOB will not flag it at all.
  83
  84 10. BUDDY
  85     a free memory block managed by the buddy system allocator
  86     The buddy system organizes free memory in blocks of various orders.
  87     An order N block has 2^N physically contiguous pages, with the BUDDY flag
  88     set for and _only_ for the first page.
  89
  90 15. COMPOUND_HEAD
  91 16. COMPOUND_TAIL
  92     A compound page with order N consists of 2^N physically contiguous pages.
  93     A compound page with order 2 takes the form of "HTTT", where H donates its
  94     head page and T donates its tail page(s).  The major consumers of compound
  95     pages are hugeTLB pages (Documentation/vm/hugetlbpage.txt), the SLUB etc.
  96     memory allocators and various device drivers. However in this interface,
  97     only huge/giga pages are made visible to end users.
  98 17. HUGE
  99     this is an integral part of a HugeTLB page
 100
 101 19. HWPOISON
 102     hardware detected memory corruption on this page: don't touch the data!
 103
 104 20. NOPAGE
 105     no page frame exists at the requested address
 106
 107 21. KSM
 108     identical memory pages dynamically shared between one or more processes
 109
 110 22. THP
 111     contiguous pages which construct transparent hugepages
 112
 113 23. BALLOON
 114     balloon compaction page
 115
 116 24. ZERO_PAGE
 117     zero page for pfn_zero or huge_zero page
 118
 119     [IO related page flags]
 120  1. ERROR     IO error occurred
 121  3. UPTODATE  page has up-to-date data
 122               ie. for file backed page: (in-memory data revision >= on-disk one)
 123  4. DIRTY     page has been written to, hence contains new data
 124               ie. for file backed page: (in-memory data revision >  on-disk one)
 125  8. WRITEBACK page is being synced to disk
 126
 127     [LRU related page flags]
 128  5. LRU         page is in one of the LRU lists
 129  6. ACTIVE      page is in the active LRU list
 130 18. UNEVICTABLE page is in the unevictable (non-)LRU list
 131                 It is somehow pinned and not a candidate for LRU page reclaims,
 132                 eg. ramfs pages, shmctl(SHM_LOCK) and mlock() memory segments
 133  2. REFERENCED  page has been referenced since last LRU list enqueue/requeue
 134  9. RECLAIM     page will be reclaimed soon after its pageout IO completed
 135 11. MMAP        a memory mapped page
 136 12. ANON        a memory mapped page that is not part of a file
 137 13. SWAPCACHE   page is mapped to swap space, ie. has an associated swap entry
 138 14. SWAPBACKED  page is backed by swap/RAM
 139
 140 The page-types tool in the tools/vm directory can be used to query the
 141 above flags.
 142
 143 Using pagemap to do something useful:
 144
 145 The general procedure for using pagemap to find out about a process' memory
 146 usage goes like this:
 147
 148  1. Read /proc/pid/maps to determine which parts of the memory space are
 149     mapped to what.
 150  2. Select the maps you are interested in -- all of them, or a particular
 151     library, or the stack or the heap, etc.
 152  3. Open /proc/pid/pagemap and seek to the pages you would like to examine.
 153  4. Read a u64 for each page from pagemap.
 154  5. Open /proc/kpagecount and/or /proc/kpageflags.  For each PFN you just
 155     read, seek to that entry in the file, and read the data you want.
 156
 157 For example, to find the "unique set size" (USS), which is the amount of
 158 memory that a process is using that is not shared with any other process,
 159 you can go through every map in the process, find the PFNs, look those up
 160 in kpagecount, and tally up the number of pages that are only referenced
 161 once.
 162
 163 Other notes:
 164
 165 Reading from any of the files will return -EINVAL if you are not starting
 166 the read on an 8-byte boundary (e.g., if you sought an odd number of bytes
 167 into the file), or if the size of the read is not a multiple of 8 bytes.
 168
 169 Before Linux 3.11 pagemap bits 55-60 were used for "page-shift" (which is
 170 always 12 at most architectures). Since Linux 3.11 their meaning changes
 171 after first clear of soft-dirty bits. Since Linux 4.2 they are used for
 172 flags unconditionally.