]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef _LINUX_RMAP_H |
2 | #define _LINUX_RMAP_H | |
3 | /* | |
4 | * Declarations for Reverse Mapping functions in mm/rmap.c | |
5 | */ | |
6 | ||
1da177e4 LT |
7 | #include <linux/list.h> |
8 | #include <linux/slab.h> | |
9 | #include <linux/mm.h> | |
5a505085 | 10 | #include <linux/rwsem.h> |
bed7161a | 11 | #include <linux/memcontrol.h> |
1da177e4 LT |
12 | |
13 | /* | |
14 | * The anon_vma heads a list of private "related" vmas, to scan if | |
15 | * an anonymous page pointing to this anon_vma needs to be unmapped: | |
16 | * the vmas on the list will be related by forking, or by splitting. | |
17 | * | |
18 | * Since vmas come and go as they are split and merged (particularly | |
19 | * in mprotect), the mapping field of an anonymous page cannot point | |
20 | * directly to a vma: instead it points to an anon_vma, on whose list | |
21 | * the related vmas can be easily linked or unlinked. | |
22 | * | |
23 | * After unlinking the last vma on the list, we must garbage collect | |
24 | * the anon_vma object itself: we're guaranteed no page can be | |
25 | * pointing to this anon_vma once its vma list is empty. | |
26 | */ | |
27 | struct anon_vma { | |
5a505085 IM |
28 | struct anon_vma *root; /* Root of this anon_vma tree */ |
29 | struct rw_semaphore rwsem; /* W: modification, R: walking the list */ | |
7f60c214 | 30 | /* |
83813267 | 31 | * The refcount is taken on an anon_vma when there is no |
7f60c214 MG |
32 | * guarantee that the vma of page tables will exist for |
33 | * the duration of the operation. A caller that takes | |
34 | * the reference is responsible for clearing up the | |
35 | * anon_vma if they are the last user on release | |
36 | */ | |
83813267 PZ |
37 | atomic_t refcount; |
38 | ||
7a3ef208 KK |
39 | /* |
40 | * Count of child anon_vmas and VMAs which points to this anon_vma. | |
41 | * | |
42 | * This counter is used for making decision about reusing anon_vma | |
43 | * instead of forking new one. See comments in function anon_vma_clone. | |
44 | */ | |
45 | unsigned degree; | |
46 | ||
47 | struct anon_vma *parent; /* Parent of this anon_vma */ | |
48 | ||
7906d00c | 49 | /* |
bf181b9f | 50 | * NOTE: the LSB of the rb_root.rb_node is set by |
7906d00c | 51 | * mm_take_all_locks() _after_ taking the above lock. So the |
bf181b9f | 52 | * rb_root must only be read/written after taking the above lock |
7906d00c AA |
53 | * to be sure to see a valid next pointer. The LSB bit itself |
54 | * is serialized by a system wide lock only visible to | |
55 | * mm_take_all_locks() (mm_all_locks_mutex). | |
56 | */ | |
bf181b9f | 57 | struct rb_root rb_root; /* Interval tree of private "related" vmas */ |
5beb4930 RR |
58 | }; |
59 | ||
60 | /* | |
61 | * The copy-on-write semantics of fork mean that an anon_vma | |
62 | * can become associated with multiple processes. Furthermore, | |
63 | * each child process will have its own anon_vma, where new | |
64 | * pages for that process are instantiated. | |
65 | * | |
66 | * This structure allows us to find the anon_vmas associated | |
67 | * with a VMA, or the VMAs associated with an anon_vma. | |
68 | * The "same_vma" list contains the anon_vma_chains linking | |
69 | * all the anon_vmas associated with this VMA. | |
bf181b9f | 70 | * The "rb" field indexes on an interval tree the anon_vma_chains |
5beb4930 RR |
71 | * which link all the VMAs associated with this anon_vma. |
72 | */ | |
73 | struct anon_vma_chain { | |
74 | struct vm_area_struct *vma; | |
75 | struct anon_vma *anon_vma; | |
76 | struct list_head same_vma; /* locked by mmap_sem & page_table_lock */ | |
5a505085 | 77 | struct rb_node rb; /* locked by anon_vma->rwsem */ |
bf181b9f | 78 | unsigned long rb_subtree_last; |
ed8ea815 ML |
79 | #ifdef CONFIG_DEBUG_VM_RB |
80 | unsigned long cached_vma_start, cached_vma_last; | |
81 | #endif | |
1da177e4 LT |
82 | }; |
83 | ||
02c6de8d | 84 | enum ttu_flags { |
daa5ba76 KK |
85 | TTU_UNMAP = 1, /* unmap mode */ |
86 | TTU_MIGRATION = 2, /* migration mode */ | |
87 | TTU_MUNLOCK = 4, /* munlock mode */ | |
854e9ed0 | 88 | TTU_LZFREE = 8, /* lazy free mode */ |
02c6de8d MK |
89 | |
90 | TTU_IGNORE_MLOCK = (1 << 8), /* ignore mlock */ | |
91 | TTU_IGNORE_ACCESS = (1 << 9), /* don't age */ | |
92 | TTU_IGNORE_HWPOISON = (1 << 10),/* corrupted page is recoverable */ | |
72b252ae MG |
93 | TTU_BATCH_FLUSH = (1 << 11), /* Batch TLB flushes where possible |
94 | * and caller guarantees they will | |
95 | * do a final flush if necessary */ | |
02c6de8d MK |
96 | }; |
97 | ||
1da177e4 | 98 | #ifdef CONFIG_MMU |
76545066 RR |
99 | static inline void get_anon_vma(struct anon_vma *anon_vma) |
100 | { | |
83813267 | 101 | atomic_inc(&anon_vma->refcount); |
76545066 RR |
102 | } |
103 | ||
01d8b20d PZ |
104 | void __put_anon_vma(struct anon_vma *anon_vma); |
105 | ||
106 | static inline void put_anon_vma(struct anon_vma *anon_vma) | |
107 | { | |
108 | if (atomic_dec_and_test(&anon_vma->refcount)) | |
109 | __put_anon_vma(anon_vma); | |
110 | } | |
1da177e4 | 111 | |
4fc3f1d6 | 112 | static inline void anon_vma_lock_write(struct anon_vma *anon_vma) |
cba48b98 | 113 | { |
5a505085 | 114 | down_write(&anon_vma->root->rwsem); |
cba48b98 RR |
115 | } |
116 | ||
08b52706 | 117 | static inline void anon_vma_unlock_write(struct anon_vma *anon_vma) |
cba48b98 | 118 | { |
5a505085 | 119 | up_write(&anon_vma->root->rwsem); |
cba48b98 RR |
120 | } |
121 | ||
4fc3f1d6 IM |
122 | static inline void anon_vma_lock_read(struct anon_vma *anon_vma) |
123 | { | |
124 | down_read(&anon_vma->root->rwsem); | |
125 | } | |
126 | ||
127 | static inline void anon_vma_unlock_read(struct anon_vma *anon_vma) | |
128 | { | |
129 | up_read(&anon_vma->root->rwsem); | |
130 | } | |
131 | ||
132 | ||
1da177e4 LT |
133 | /* |
134 | * anon_vma helper functions. | |
135 | */ | |
136 | void anon_vma_init(void); /* create anon_vma_cachep */ | |
137 | int anon_vma_prepare(struct vm_area_struct *); | |
5beb4930 RR |
138 | void unlink_anon_vmas(struct vm_area_struct *); |
139 | int anon_vma_clone(struct vm_area_struct *, struct vm_area_struct *); | |
140 | int anon_vma_fork(struct vm_area_struct *, struct vm_area_struct *); | |
1da177e4 | 141 | |
5beb4930 RR |
142 | static inline void anon_vma_merge(struct vm_area_struct *vma, |
143 | struct vm_area_struct *next) | |
144 | { | |
81d1b09c | 145 | VM_BUG_ON_VMA(vma->anon_vma != next->anon_vma, vma); |
5beb4930 RR |
146 | unlink_anon_vmas(next); |
147 | } | |
148 | ||
01d8b20d PZ |
149 | struct anon_vma *page_get_anon_vma(struct page *page); |
150 | ||
d281ee61 KS |
151 | /* bitflags for do_page_add_anon_rmap() */ |
152 | #define RMAP_EXCLUSIVE 0x01 | |
153 | #define RMAP_COMPOUND 0x02 | |
154 | ||
1da177e4 LT |
155 | /* |
156 | * rmap interfaces called when adding or removing pte of page | |
157 | */ | |
c44b6743 | 158 | void page_move_anon_rmap(struct page *, struct vm_area_struct *, unsigned long); |
d281ee61 KS |
159 | void page_add_anon_rmap(struct page *, struct vm_area_struct *, |
160 | unsigned long, bool); | |
ad8c2ee8 RR |
161 | void do_page_add_anon_rmap(struct page *, struct vm_area_struct *, |
162 | unsigned long, int); | |
d281ee61 KS |
163 | void page_add_new_anon_rmap(struct page *, struct vm_area_struct *, |
164 | unsigned long, bool); | |
1da177e4 | 165 | void page_add_file_rmap(struct page *); |
d281ee61 | 166 | void page_remove_rmap(struct page *, bool); |
1da177e4 | 167 | |
0fe6e20b NH |
168 | void hugepage_add_anon_rmap(struct page *, struct vm_area_struct *, |
169 | unsigned long); | |
170 | void hugepage_add_new_anon_rmap(struct page *, struct vm_area_struct *, | |
171 | unsigned long); | |
172 | ||
53f9263b | 173 | static inline void page_dup_rmap(struct page *page, bool compound) |
1da177e4 | 174 | { |
53f9263b | 175 | atomic_inc(compound ? compound_mapcount_ptr(page) : &page->_mapcount); |
1da177e4 LT |
176 | } |
177 | ||
178 | /* | |
179 | * Called from mm/vmscan.c to handle paging out | |
180 | */ | |
6fe6b7e3 | 181 | int page_referenced(struct page *, int is_locked, |
72835c86 | 182 | struct mem_cgroup *memcg, unsigned long *vm_flags); |
5ad64688 | 183 | |
14fa31b8 AK |
184 | #define TTU_ACTION(x) ((x) & TTU_ACTION_MASK) |
185 | ||
186 | int try_to_unmap(struct page *, enum ttu_flags flags); | |
1da177e4 | 187 | |
ceffc078 | 188 | /* |
e748dcd0 | 189 | * Used by uprobes to replace a userspace page safely |
ceffc078 | 190 | */ |
e9a81a82 | 191 | pte_t *__page_check_address(struct page *, struct mm_struct *, |
479db0bf | 192 | unsigned long, spinlock_t **, int); |
ceffc078 | 193 | |
e9a81a82 NK |
194 | static inline pte_t *page_check_address(struct page *page, struct mm_struct *mm, |
195 | unsigned long address, | |
196 | spinlock_t **ptlp, int sync) | |
197 | { | |
198 | pte_t *ptep; | |
199 | ||
200 | __cond_lock(*ptlp, ptep = __page_check_address(page, mm, address, | |
201 | ptlp, sync)); | |
202 | return ptep; | |
203 | } | |
204 | ||
8749cfea VD |
205 | /* |
206 | * Used by idle page tracking to check if a page was referenced via page | |
207 | * tables. | |
208 | */ | |
209 | #ifdef CONFIG_TRANSPARENT_HUGEPAGE | |
210 | bool page_check_address_transhuge(struct page *page, struct mm_struct *mm, | |
211 | unsigned long address, pmd_t **pmdp, | |
212 | pte_t **ptep, spinlock_t **ptlp); | |
213 | #else | |
214 | static inline bool page_check_address_transhuge(struct page *page, | |
215 | struct mm_struct *mm, unsigned long address, | |
216 | pmd_t **pmdp, pte_t **ptep, spinlock_t **ptlp) | |
217 | { | |
218 | *ptep = page_check_address(page, mm, address, ptlp, 0); | |
219 | *pmdp = NULL; | |
220 | return !!*ptep; | |
221 | } | |
222 | #endif | |
223 | ||
1da177e4 LT |
224 | /* |
225 | * Used by swapoff to help locate where page is expected in vma. | |
226 | */ | |
227 | unsigned long page_address_in_vma(struct page *, struct vm_area_struct *); | |
228 | ||
d08b3851 PZ |
229 | /* |
230 | * Cleans the PTEs of shared mappings. | |
231 | * (and since clean PTEs should also be readonly, write protects them too) | |
232 | * | |
233 | * returns the number of cleaned PTEs. | |
234 | */ | |
235 | int page_mkclean(struct page *); | |
236 | ||
b291f000 NP |
237 | /* |
238 | * called in munlock()/munmap() path to check for other vmas holding | |
239 | * the page mlocked. | |
240 | */ | |
241 | int try_to_munlock(struct page *); | |
b291f000 | 242 | |
10be22df AK |
243 | /* |
244 | * Called by memory-failure.c to kill processes. | |
245 | */ | |
4fc3f1d6 IM |
246 | struct anon_vma *page_lock_anon_vma_read(struct page *page); |
247 | void page_unlock_anon_vma_read(struct anon_vma *anon_vma); | |
6a46079c | 248 | int page_mapped_in_vma(struct page *page, struct vm_area_struct *vma); |
10be22df | 249 | |
0dd1c7bb JK |
250 | /* |
251 | * rmap_walk_control: To control rmap traversing for specific needs | |
252 | * | |
253 | * arg: passed to rmap_one() and invalid_vma() | |
254 | * rmap_one: executed on each vma where page is mapped | |
255 | * done: for checking traversing termination condition | |
0dd1c7bb JK |
256 | * anon_lock: for getting anon_lock by optimized way rather than default |
257 | * invalid_vma: for skipping uninterested vma | |
258 | */ | |
051ac83a JK |
259 | struct rmap_walk_control { |
260 | void *arg; | |
261 | int (*rmap_one)(struct page *page, struct vm_area_struct *vma, | |
262 | unsigned long addr, void *arg); | |
0dd1c7bb | 263 | int (*done)(struct page *page); |
0dd1c7bb JK |
264 | struct anon_vma *(*anon_lock)(struct page *page); |
265 | bool (*invalid_vma)(struct vm_area_struct *vma, void *arg); | |
051ac83a JK |
266 | }; |
267 | ||
051ac83a | 268 | int rmap_walk(struct page *page, struct rmap_walk_control *rwc); |
b9773199 | 269 | int rmap_walk_locked(struct page *page, struct rmap_walk_control *rwc); |
e9995ef9 | 270 | |
1da177e4 LT |
271 | #else /* !CONFIG_MMU */ |
272 | ||
273 | #define anon_vma_init() do {} while (0) | |
274 | #define anon_vma_prepare(vma) (0) | |
275 | #define anon_vma_link(vma) do {} while (0) | |
276 | ||
01ff53f4 | 277 | static inline int page_referenced(struct page *page, int is_locked, |
72835c86 | 278 | struct mem_cgroup *memcg, |
01ff53f4 MF |
279 | unsigned long *vm_flags) |
280 | { | |
281 | *vm_flags = 0; | |
64574746 | 282 | return 0; |
01ff53f4 MF |
283 | } |
284 | ||
a48d07af | 285 | #define try_to_unmap(page, refs) SWAP_FAIL |
1da177e4 | 286 | |
d08b3851 PZ |
287 | static inline int page_mkclean(struct page *page) |
288 | { | |
289 | return 0; | |
290 | } | |
291 | ||
292 | ||
1da177e4 LT |
293 | #endif /* CONFIG_MMU */ |
294 | ||
295 | /* | |
296 | * Return values of try_to_unmap | |
297 | */ | |
298 | #define SWAP_SUCCESS 0 | |
299 | #define SWAP_AGAIN 1 | |
300 | #define SWAP_FAIL 2 | |
b291f000 | 301 | #define SWAP_MLOCK 3 |
854e9ed0 | 302 | #define SWAP_LZFREE 4 |
1da177e4 LT |
303 | |
304 | #endif /* _LINUX_RMAP_H */ |