include/linux/mempolicy.h

   1 /*
   2  * NUMA memory policies for Linux.
   3  * Copyright 2003,2004 Andi Kleen SuSE Labs
   4  */
   5 #ifndef _LINUX_MEMPOLICY_H
   6 #define _LINUX_MEMPOLICY_H 1
   7
   8
   9 #include <linux/mmzone.h>
  10 #include <linux/slab.h>
  11 #include <linux/rbtree.h>
  12 #include <linux/spinlock.h>
  13 #include <linux/nodemask.h>
  14 #include <linux/pagemap.h>
  15 #include <uapi/linux/mempolicy.h>
  16
  17 struct mm_struct;
  18
  19 #ifdef CONFIG_NUMA
  20
  21 /*
  22  * Describe a memory policy.
  23  *
  24  * A mempolicy can be either associated with a process or with a VMA.
  25  * For VMA related allocations the VMA policy is preferred, otherwise
  26  * the process policy is used. Interrupts ignore the memory policy
  27  * of the current process.
  28  *
  29  * Locking policy for interlave:
  30  * In process context there is no locking because only the process accesses
  31  * its own state. All vma manipulation is somewhat protected by a down_read on
  32  * mmap_sem.
  33  *
  34  * Freeing policy:
  35  * Mempolicy objects are reference counted.  A mempolicy will be freed when
  36  * mpol_put() decrements the reference count to zero.
  37  *
  38  * Duplicating policy objects:
  39  * mpol_dup() allocates a new mempolicy and copies the specified mempolicy
  40  * to the new storage.  The reference count of the new object is initialized
  41  * to 1, representing the caller of mpol_dup().
  42  */
  43 struct mempolicy {
  44         atomic_t refcnt;
  45         unsigned short mode;    /* See MPOL_* above */
  46         unsigned short flags;   /* See set_mempolicy() MPOL_F_* above */
  47         union {
  48                 short            preferred_node; /* preferred */
  49                 nodemask_t       nodes;         /* interleave/bind */
  50                 /* undefined for default */
  51         } v;
  52         union {
  53                 nodemask_t cpuset_mems_allowed; /* relative to these nodes */
  54                 nodemask_t user_nodemask;       /* nodemask passed by user */
  55         } w;
  56 };
  57
  58 /*
  59  * Support for managing mempolicy data objects (clone, copy, destroy)
  60  * The default fast path of a NULL MPOL_DEFAULT policy is always inlined.
  61  */
  62
  63 extern void __mpol_put(struct mempolicy *pol);
  64 static inline void mpol_put(struct mempolicy *pol)
  65 {
  66         if (pol)
  67                 __mpol_put(pol);
  68 }
  69
  70 /*
  71  * Does mempolicy pol need explicit unref after use?
  72  * Currently only needed for shared policies.
  73  */
  74 static inline int mpol_needs_cond_ref(struct mempolicy *pol)
  75 {
  76         return (pol && (pol->flags & MPOL_F_SHARED));
  77 }
  78
  79 static inline void mpol_cond_put(struct mempolicy *pol)
  80 {
  81         if (mpol_needs_cond_ref(pol))
  82                 __mpol_put(pol);
  83 }
  84
  85 extern struct mempolicy *__mpol_dup(struct mempolicy *pol);
  86 static inline struct mempolicy *mpol_dup(struct mempolicy *pol)
  87 {
  88         if (pol)
  89                 pol = __mpol_dup(pol);
  90         return pol;
  91 }
  92
  93 #define vma_policy(vma) ((vma)->vm_policy)
  94
  95 static inline void mpol_get(struct mempolicy *pol)
  96 {
  97         if (pol)
  98                 atomic_inc(&pol->refcnt);
  99 }
 100
 101 extern bool __mpol_equal(struct mempolicy *a, struct mempolicy *b);
 102 static inline bool mpol_equal(struct mempolicy *a, struct mempolicy *b)
 103 {
 104         if (a == b)
 105                 return true;
 106         return __mpol_equal(a, b);
 107 }
 108
 109 /*
 110  * Tree of shared policies for a shared memory region.
 111  * Maintain the policies in a pseudo mm that contains vmas. The vmas
 112  * carry the policy. As a special twist the pseudo mm is indexed in pages, not
 113  * bytes, so that we can work with shared memory segments bigger than
 114  * unsigned long.
 115  */
 116
 117 struct sp_node {
 118         struct rb_node nd;
 119         unsigned long start, end;
 120         struct mempolicy *policy;
 121 };
 122
 123 struct shared_policy {
 124         struct rb_root root;
 125         spinlock_t lock;
 126 };
 127
 128 int vma_dup_policy(struct vm_area_struct *src, struct vm_area_struct *dst);
 129 void mpol_shared_policy_init(struct shared_policy *sp, struct mempolicy *mpol);
 130 int mpol_set_shared_policy(struct shared_policy *info,
 131                                 struct vm_area_struct *vma,
 132                                 struct mempolicy *new);
 133 void mpol_free_shared_policy(struct shared_policy *p);
 134 struct mempolicy *mpol_shared_policy_lookup(struct shared_policy *sp,
 135                                             unsigned long idx);
 136
 137 struct mempolicy *get_task_policy(struct task_struct *p);
 138 struct mempolicy *__get_vma_policy(struct vm_area_struct *vma,
 139                 unsigned long addr);
 140 struct mempolicy *get_vma_policy(struct task_struct *tsk,
 141                 struct vm_area_struct *vma, unsigned long addr);
 142 bool vma_policy_mof(struct vm_area_struct *vma);
 143
 144 extern void numa_default_policy(void);
 145 extern void numa_policy_init(void);
 146 extern void mpol_rebind_task(struct task_struct *tsk, const nodemask_t *new,
 147                                 enum mpol_rebind_step step);
 148 extern void mpol_rebind_mm(struct mm_struct *mm, nodemask_t *new);
 149
 150 extern struct zonelist *huge_zonelist(struct vm_area_struct *vma,
 151                                 unsigned long addr, gfp_t gfp_flags,
 152                                 struct mempolicy **mpol, nodemask_t **nodemask);
 153 extern bool init_nodemask_of_mempolicy(nodemask_t *mask);
 154 extern bool mempolicy_nodemask_intersects(struct task_struct *tsk,
 155                                 const nodemask_t *mask);
 156 extern unsigned int mempolicy_slab_node(void);
 157
 158 extern enum zone_type policy_zone;
 159
 160 static inline void check_highest_zone(enum zone_type k)
 161 {
 162         if (k > policy_zone && k != ZONE_MOVABLE)
 163                 policy_zone = k;
 164 }
 165
 166 int do_migrate_pages(struct mm_struct *mm, const nodemask_t *from,
 167                      const nodemask_t *to, int flags);
 168
 169
 170 #ifdef CONFIG_TMPFS
 171 extern int mpol_parse_str(char *str, struct mempolicy **mpol);
 172 #endif
 173
 174 extern void mpol_to_str(char *buffer, int maxlen, struct mempolicy *pol);
 175
 176 /* Check if a vma is migratable */
 177 static inline int vma_migratable(struct vm_area_struct *vma)
 178 {
 179         if (vma->vm_flags & (VM_IO | VM_PFNMAP))
 180                 return 0;
 181
 182 #ifndef CONFIG_ARCH_ENABLE_HUGEPAGE_MIGRATION
 183         if (vma->vm_flags & VM_HUGETLB)
 184                 return 0;
 185 #endif
 186
 187         /*
 188          * Migration allocates pages in the highest zone. If we cannot
 189          * do so then migration (at least from node to node) is not
 190          * possible.
 191          */
 192         if (vma->vm_file &&
 193                 gfp_zone(mapping_gfp_mask(vma->vm_file->f_mapping))
 194                                                                 < policy_zone)
 195                         return 0;
 196         return 1;
 197 }
 198
 199 extern int mpol_misplaced(struct page *, struct vm_area_struct *, unsigned long);
 200
 201 #else
 202
 203 struct mempolicy {};
 204
 205 static inline bool mpol_equal(struct mempolicy *a, struct mempolicy *b)
 206 {
 207         return true;
 208 }
 209
 210 static inline void mpol_put(struct mempolicy *p)
 211 {
 212 }
 213
 214 static inline void mpol_cond_put(struct mempolicy *pol)
 215 {
 216 }
 217
 218 static inline void mpol_get(struct mempolicy *pol)
 219 {
 220 }
 221
 222 struct shared_policy {};
 223
 224 static inline void mpol_shared_policy_init(struct shared_policy *sp,
 225                                                 struct mempolicy *mpol)
 226 {
 227 }
 228
 229 static inline void mpol_free_shared_policy(struct shared_policy *p)
 230 {
 231 }
 232
 233 #define vma_policy(vma) NULL
 234
 235 static inline int
 236 vma_dup_policy(struct vm_area_struct *src, struct vm_area_struct *dst)
 237 {
 238         return 0;
 239 }
 240
 241 static inline void numa_policy_init(void)
 242 {
 243 }
 244
 245 static inline void numa_default_policy(void)
 246 {
 247 }
 248
 249 static inline void mpol_rebind_task(struct task_struct *tsk,
 250                                 const nodemask_t *new,
 251                                 enum mpol_rebind_step step)
 252 {
 253 }
 254
 255 static inline void mpol_rebind_mm(struct mm_struct *mm, nodemask_t *new)
 256 {
 257 }
 258
 259 static inline struct zonelist *huge_zonelist(struct vm_area_struct *vma,
 260                                 unsigned long addr, gfp_t gfp_flags,
 261                                 struct mempolicy **mpol, nodemask_t **nodemask)
 262 {
 263         *mpol = NULL;
 264         *nodemask = NULL;
 265         return node_zonelist(0, gfp_flags);
 266 }
 267
 268 static inline bool init_nodemask_of_mempolicy(nodemask_t *m)
 269 {
 270         return false;
 271 }
 272
 273 static inline int do_migrate_pages(struct mm_struct *mm, const nodemask_t *from,
 274                                    const nodemask_t *to, int flags)
 275 {
 276         return 0;
 277 }
 278
 279 static inline void check_highest_zone(int k)
 280 {
 281 }
 282
 283 #ifdef CONFIG_TMPFS
 284 static inline int mpol_parse_str(char *str, struct mempolicy **mpol)
 285 {
 286         return 1;       /* error */
 287 }
 288 #endif
 289
 290 static inline int mpol_misplaced(struct page *page, struct vm_area_struct *vma,
 291                                  unsigned long address)
 292 {
 293         return -1; /* no node preference */
 294 }
 295
 296 #endif /* CONFIG_NUMA */
 297 #endif