Skip to content

Commit 0d16cfd

Browse files
sjp38torvalds
authored andcommitted
Docs/admin-guide/mm/pagemap: wordsmith page flags descriptions
Some descriptions of page flags in 'pagemap.rst' are written in assumption of none-rst, which respects every new line, as below: 7 - SLAB page is managed by the SLAB/SLOB/SLUB/SLQB kernel memory allocator When compound page is used, SLUB/SLQB will only set this flag on the head Because rst ignores the new line between the first sentence and second sentence, resulting html looks a little bit weird, as below. 7 - SLAB page is managed by the SLAB/SLOB/SLUB/SLQB kernel memory allocator When ^ compound page is used, SLUB/SLQB will only set this flag on the head page; SLOB will not flag it at all. This change makes it more natural and consistent with other parts in the rendered version. Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: SeongJae Park <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Peter Xu <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
1 parent b1eee3c commit 0d16cfd

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

Documentation/admin-guide/mm/pagemap.rst

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,14 @@ Short descriptions to the page flags
9090
====================================
9191

9292
0 - LOCKED
93-
page is being locked for exclusive access, e.g. by undergoing read/write IO
93+
The page is being locked for exclusive access, e.g. by undergoing read/write
94+
IO.
9495
7 - SLAB
95-
page is managed by the SLAB/SLOB/SLUB/SLQB kernel memory allocator
96+
The page is managed by the SLAB/SLOB/SLUB/SLQB kernel memory allocator.
9697
When compound page is used, SLUB/SLQB will only set this flag on the head
9798
page; SLOB will not flag it at all.
9899
10 - BUDDY
99-
a free memory block managed by the buddy system allocator
100+
A free memory block managed by the buddy system allocator.
100101
The buddy system organizes free memory in blocks of various orders.
101102
An order N block has 2^N physically contiguous pages, with the BUDDY flag
102103
set for and _only_ for the first page.
@@ -112,65 +113,65 @@ Short descriptions to the page flags
112113
16 - COMPOUND_TAIL
113114
A compound page tail (see description above).
114115
17 - HUGE
115-
this is an integral part of a HugeTLB page
116+
This is an integral part of a HugeTLB page.
116117
19 - HWPOISON
117-
hardware detected memory corruption on this page: don't touch the data!
118+
Hardware detected memory corruption on this page: don't touch the data!
118119
20 - NOPAGE
119-
no page frame exists at the requested address
120+
No page frame exists at the requested address.
120121
21 - KSM
121-
identical memory pages dynamically shared between one or more processes
122+
Identical memory pages dynamically shared between one or more processes.
122123
22 - THP
123-
contiguous pages which construct transparent hugepages
124+
Contiguous pages which construct transparent hugepages.
124125
23 - OFFLINE
125-
page is logically offline
126+
The page is logically offline.
126127
24 - ZERO_PAGE
127-
zero page for pfn_zero or huge_zero page
128+
Zero page for pfn_zero or huge_zero page.
128129
25 - IDLE
129-
page has not been accessed since it was marked idle (see
130+
The page has not been accessed since it was marked idle (see
130131
:ref:`Documentation/admin-guide/mm/idle_page_tracking.rst <idle_page_tracking>`).
131132
Note that this flag may be stale in case the page was accessed via
132133
a PTE. To make sure the flag is up-to-date one has to read
133134
``/sys/kernel/mm/page_idle/bitmap`` first.
134135
26 - PGTABLE
135-
page is in use as a page table
136+
The page is in use as a page table.
136137

137138
IO related page flags
138139
---------------------
139140

140141
1 - ERROR
141-
IO error occurred
142+
IO error occurred.
142143
3 - UPTODATE
143-
page has up-to-date data
144+
The page has up-to-date data.
144145
ie. for file backed page: (in-memory data revision >= on-disk one)
145146
4 - DIRTY
146-
page has been written to, hence contains new data
147+
The page has been written to, hence contains new data.
147148
i.e. for file backed page: (in-memory data revision > on-disk one)
148149
8 - WRITEBACK
149-
page is being synced to disk
150+
The page is being synced to disk.
150151

151152
LRU related page flags
152153
----------------------
153154

154155
5 - LRU
155-
page is in one of the LRU lists
156+
The page is in one of the LRU lists.
156157
6 - ACTIVE
157-
page is in the active LRU list
158+
The page is in the active LRU list.
158159
18 - UNEVICTABLE
159-
page is in the unevictable (non-)LRU list It is somehow pinned and
160+
The page is in the unevictable (non-)LRU list It is somehow pinned and
160161
not a candidate for LRU page reclaims, e.g. ramfs pages,
161-
shmctl(SHM_LOCK) and mlock() memory segments
162+
shmctl(SHM_LOCK) and mlock() memory segments.
162163
2 - REFERENCED
163-
page has been referenced since last LRU list enqueue/requeue
164+
The page has been referenced since last LRU list enqueue/requeue.
164165
9 - RECLAIM
165-
page will be reclaimed soon after its pageout IO completed
166+
The page will be reclaimed soon after its pageout IO completed.
166167
11 - MMAP
167-
a memory mapped page
168+
A memory mapped page.
168169
12 - ANON
169-
a memory mapped page that is not part of a file
170+
A memory mapped page that is not part of a file.
170171
13 - SWAPCACHE
171-
page is mapped to swap space, i.e. has an associated swap entry
172+
The page is mapped to swap space, i.e. has an associated swap entry.
172173
14 - SWAPBACKED
173-
page is backed by swap/RAM
174+
The page is backed by swap/RAM.
174175

175176
The page-types tool in the tools/vm directory can be used to query the
176177
above flags.

0 commit comments

Comments
 (0)