include/linux/rmap.h

   1 #ifndef _LINUX_RMAP_H
   2 #define _LINUX_RMAP_H
   3 /*
   4  * Declarations for Reverse Mapping functions in mm/rmap.c
   5  */
   6
   7 #include <linux/list.h>
   8 #include <linux/slab.h>
   9 #include <linux/mm.h>
  10 #include <linux/spinlock.h>
  11 #include <linux/memcontrol.h>
  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 {
  28         spinlock_t lock;        /* Serialize access to vma list */
  29         /*
  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          */
  37         struct list_head head;  /* List of private "related" vmas */
  38 };
  39
  40 #ifdef CONFIG_MMU
  41
  42 static inline struct anon_vma *page_anon_vma(struct page *page)
  43 {
  44         if (((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) !=
  45                                             PAGE_MAPPING_ANON)
  46                 return NULL;
  47         return page_rmapping(page);
  48 }
  49
  50 static inline void anon_vma_lock(struct vm_area_struct *vma)
  51 {
  52         struct anon_vma *anon_vma = vma->anon_vma;
  53         if (anon_vma)
  54                 spin_lock(&anon_vma->lock);
  55 }
  56
  57 static inline void anon_vma_unlock(struct vm_area_struct *vma)
  58 {
  59         struct anon_vma *anon_vma = vma->anon_vma;
  60         if (anon_vma)
  61                 spin_unlock(&anon_vma->lock);
  62 }
  63
  64 /*
  65  * anon_vma helper functions.
  66  */
  67 void anon_vma_init(void);       /* create anon_vma_cachep */
  68 int  anon_vma_prepare(struct vm_area_struct *);
  69 void __anon_vma_merge(struct vm_area_struct *, struct vm_area_struct *);
  70 void anon_vma_unlink(struct vm_area_struct *);
  71 void anon_vma_link(struct vm_area_struct *);
  72 void __anon_vma_link(struct vm_area_struct *);
  73
  74 /*
  75  * rmap interfaces called when adding or removing pte of page
  76  */
  77 void page_add_anon_rmap(struct page *, struct vm_area_struct *, unsigned long);
  78 void page_add_new_anon_rmap(struct page *, struct vm_area_struct *, unsigned long);
  79 void page_add_file_rmap(struct page *);
  80 void page_remove_rmap(struct page *);
  81
  82 static inline void page_dup_rmap(struct page *page)
  83 {
  84         atomic_inc(&page->_mapcount);
  85 }
  86
  87 /*
  88  * Called from mm/vmscan.c to handle paging out
  89  */
  90 int page_referenced(struct page *, int is_locked,
  91                         struct mem_cgroup *cnt, unsigned long *vm_flags);
  92 enum ttu_flags {
  93         TTU_UNMAP = 0,                  /* unmap mode */
  94         TTU_MIGRATION = 1,              /* migration mode */
  95         TTU_MUNLOCK = 2,                /* munlock mode */
  96         TTU_ACTION_MASK = 0xff,
  97
  98         TTU_IGNORE_MLOCK = (1 << 8),    /* ignore mlock */
  99         TTU_IGNORE_ACCESS = (1 << 9),   /* don't age */
 100         TTU_IGNORE_HWPOISON = (1 << 10),/* corrupted page is recoverable */
 101 };
 102 #define TTU_ACTION(x) ((x) & TTU_ACTION_MASK)
 103
 104 int try_to_unmap(struct page *, enum ttu_flags flags);
 105
 106 /*
 107  * Called from mm/filemap_xip.c to unmap empty zero page
 108  */
 109 pte_t *page_check_address(struct page *, struct mm_struct *,
 110                                 unsigned long, spinlock_t **, int);
 111
 112 /*
 113  * Used by swapoff to help locate where page is expected in vma.
 114  */
 115 unsigned long page_address_in_vma(struct page *, struct vm_area_struct *);
 116
 117 /*
 118  * Cleans the PTEs of shared mappings.
 119  * (and since clean PTEs should also be readonly, write protects them too)
 120  *
 121  * returns the number of cleaned PTEs.
 122  */
 123 int page_mkclean(struct page *);
 124
 125 /*
 126  * called in munlock()/munmap() path to check for other vmas holding
 127  * the page mlocked.
 128  */
 129 int try_to_munlock(struct page *);
 130
 131 /*
 132  * Called by memory-failure.c to kill processes.
 133  */
 134 struct anon_vma *page_lock_anon_vma(struct page *page);
 135 void page_unlock_anon_vma(struct anon_vma *anon_vma);
 136 int page_mapped_in_vma(struct page *page, struct vm_area_struct *vma);
 137
 138 #else   /* !CONFIG_MMU */
 139
 140 #define anon_vma_init()         do {} while (0)
 141 #define anon_vma_prepare(vma)   (0)
 142 #define anon_vma_link(vma)      do {} while (0)
 143
 144 static inline int page_referenced(struct page *page, int is_locked,
 145                                   struct mem_cgroup *cnt,
 146                                   unsigned long *vm_flags)
 147 {
 148         *vm_flags = 0;
 149         return TestClearPageReferenced(page);
 150 }
 151
 152 #define try_to_unmap(page, refs) SWAP_FAIL
 153
 154 static inline int page_mkclean(struct page *page)
 155 {
 156         return 0;
 157 }
 158
 159
 160 #endif  /* CONFIG_MMU */
 161
 162 /*
 163  * Return values of try_to_unmap
 164  */
 165 #define SWAP_SUCCESS    0
 166 #define SWAP_AGAIN      1
 167 #define SWAP_FAIL       2
 168 #define SWAP_MLOCK      3
 169
 170 #endif  /* _LINUX_RMAP_H */