blob: fed6f5e0b41139070dd9c99b84ee324e7254f63f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_RMAP_H
2#define _LINUX_RMAP_H
3/*
4 * Declarations for Reverse Mapping functions in mm/rmap.c
5 */
6
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/list.h>
8#include <linux/slab.h>
9#include <linux/mm.h>
10#include <linux/spinlock.h>
Balbir Singhbed71612008-02-07 00:14:01 -080011#include <linux/memcontrol.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
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 */
27struct anon_vma {
28 spinlock_t lock; /* Serialize access to vma list */
Andrea Arcangeli7906d002008-07-28 15:46:26 -070029 /*
30 * NOTE: the LSB of the head.next is set by
31 * mm_take_all_locks() _after_ taking the above lock. So the
32 * head must only be read/written after taking the above lock
33 * to be sure to see a valid next pointer. The LSB bit itself
34 * is serialized by a system wide lock only visible to
35 * mm_take_all_locks() (mm_all_locks_mutex).
36 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 struct list_head head; /* List of private "related" vmas */
38};
39
40#ifdef CONFIG_MMU
41
Christoph Lametere18b8902006-12-06 20:33:20 -080042extern struct kmem_cache *anon_vma_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44static inline struct anon_vma *anon_vma_alloc(void)
45{
Christoph Lametere94b1762006-12-06 20:33:17 -080046 return kmem_cache_alloc(anon_vma_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047}
48
49static inline void anon_vma_free(struct anon_vma *anon_vma)
50{
51 kmem_cache_free(anon_vma_cachep, anon_vma);
52}
53
54static inline void anon_vma_lock(struct vm_area_struct *vma)
55{
56 struct anon_vma *anon_vma = vma->anon_vma;
57 if (anon_vma)
58 spin_lock(&anon_vma->lock);
59}
60
61static inline void anon_vma_unlock(struct vm_area_struct *vma)
62{
63 struct anon_vma *anon_vma = vma->anon_vma;
64 if (anon_vma)
65 spin_unlock(&anon_vma->lock);
66}
67
68/*
69 * anon_vma helper functions.
70 */
71void anon_vma_init(void); /* create anon_vma_cachep */
72int anon_vma_prepare(struct vm_area_struct *);
73void __anon_vma_merge(struct vm_area_struct *, struct vm_area_struct *);
74void anon_vma_unlink(struct vm_area_struct *);
75void anon_vma_link(struct vm_area_struct *);
76void __anon_vma_link(struct vm_area_struct *);
77
78/*
79 * rmap interfaces called when adding or removing pte of page
80 */
81void page_add_anon_rmap(struct page *, struct vm_area_struct *, unsigned long);
Nick Piggin9617d952006-01-06 00:11:12 -080082void page_add_new_anon_rmap(struct page *, struct vm_area_struct *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083void page_add_file_rmap(struct page *);
Nick Piggin7de6b802006-12-22 01:09:33 -080084void page_remove_rmap(struct page *, struct vm_area_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Nick Pigginc97a9e12007-05-16 22:11:21 -070086#ifdef CONFIG_DEBUG_VM
87void page_dup_rmap(struct page *page, struct vm_area_struct *vma, unsigned long address);
88#else
89static inline void page_dup_rmap(struct page *page, struct vm_area_struct *vma, unsigned long address)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090{
91 atomic_inc(&page->_mapcount);
92}
Nick Pigginc97a9e12007-05-16 22:11:21 -070093#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95/*
96 * Called from mm/vmscan.c to handle paging out
97 */
Balbir Singhbed71612008-02-07 00:14:01 -080098int page_referenced(struct page *, int is_locked, struct mem_cgroup *cnt);
Christoph Lametera48d07a2006-02-01 03:05:38 -080099int try_to_unmap(struct page *, int ignore_refs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101/*
Carsten Otteceffc072005-06-23 22:05:25 -0700102 * Called from mm/filemap_xip.c to unmap empty zero page
103 */
Hugh Dickinsc0718802005-10-29 18:16:31 -0700104pte_t *page_check_address(struct page *, struct mm_struct *,
Nick Piggin479db0b2008-08-20 14:09:18 -0700105 unsigned long, spinlock_t **, int);
Carsten Otteceffc072005-06-23 22:05:25 -0700106
107/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 * Used by swapoff to help locate where page is expected in vma.
109 */
110unsigned long page_address_in_vma(struct page *, struct vm_area_struct *);
111
Peter Zijlstrad08b3852006-09-25 23:30:57 -0700112/*
113 * Cleans the PTEs of shared mappings.
114 * (and since clean PTEs should also be readonly, write protects them too)
115 *
116 * returns the number of cleaned PTEs.
117 */
118int page_mkclean(struct page *);
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120#else /* !CONFIG_MMU */
121
122#define anon_vma_init() do {} while (0)
123#define anon_vma_prepare(vma) (0)
124#define anon_vma_link(vma) do {} while (0)
125
Balbir Singhbed71612008-02-07 00:14:01 -0800126#define page_referenced(page,l,cnt) TestClearPageReferenced(page)
Christoph Lametera48d07a2006-02-01 03:05:38 -0800127#define try_to_unmap(page, refs) SWAP_FAIL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Peter Zijlstrad08b3852006-09-25 23:30:57 -0700129static inline int page_mkclean(struct page *page)
130{
131 return 0;
132}
133
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135#endif /* CONFIG_MMU */
136
137/*
138 * Return values of try_to_unmap
139 */
140#define SWAP_SUCCESS 0
141#define SWAP_AGAIN 1
142#define SWAP_FAIL 2
143
144#endif /* _LINUX_RMAP_H */