mempolicy: support optional mode flags
[linux-2.6.git] / include / linux / mempolicy.h
1 #ifndef _LINUX_MEMPOLICY_H
2 #define _LINUX_MEMPOLICY_H 1
3
4 #include <linux/errno.h>
5
6 /*
7  * NUMA memory policies for Linux.
8  * Copyright 2003,2004 Andi Kleen SuSE Labs
9  */
10
11 /*
12  * Both the MPOL_* mempolicy mode and the MPOL_F_* optional mode flags are
13  * passed by the user to either set_mempolicy() or mbind() in an 'int' actual.
14  * The MPOL_MODE_FLAGS macro determines the legal set of optional mode flags.
15  */
16
17 /* Policies */
18 enum {
19         MPOL_DEFAULT,
20         MPOL_PREFERRED,
21         MPOL_BIND,
22         MPOL_INTERLEAVE,
23         MPOL_MAX,       /* always last member of enum */
24 };
25
26 /* Flags for set_mempolicy */
27 /*
28  * MPOL_MODE_FLAGS is the union of all possible optional mode flags passed to
29  * either set_mempolicy() or mbind().
30  */
31 #define MPOL_MODE_FLAGS (0)
32
33 /* Flags for get_mempolicy */
34 #define MPOL_F_NODE     (1<<0)  /* return next IL mode instead of node mask */
35 #define MPOL_F_ADDR     (1<<1)  /* look up vma using address */
36 #define MPOL_F_MEMS_ALLOWED (1<<2) /* return allowed memories */
37
38 /* Flags for mbind */
39 #define MPOL_MF_STRICT  (1<<0)  /* Verify existing pages in the mapping */
40 #define MPOL_MF_MOVE    (1<<1)  /* Move pages owned by this process to conform to mapping */
41 #define MPOL_MF_MOVE_ALL (1<<2) /* Move every page to conform to mapping */
42 #define MPOL_MF_INTERNAL (1<<3) /* Internal flags start here */
43
44 #ifdef __KERNEL__
45
46 #include <linux/mmzone.h>
47 #include <linux/slab.h>
48 #include <linux/rbtree.h>
49 #include <linux/spinlock.h>
50 #include <linux/nodemask.h>
51
52 struct vm_area_struct;
53 struct mm_struct;
54
55 #ifdef CONFIG_NUMA
56
57 /*
58  * Describe a memory policy.
59  *
60  * A mempolicy can be either associated with a process or with a VMA.
61  * For VMA related allocations the VMA policy is preferred, otherwise
62  * the process policy is used. Interrupts ignore the memory policy
63  * of the current process.
64  *
65  * Locking policy for interlave:
66  * In process context there is no locking because only the process accesses
67  * its own state. All vma manipulation is somewhat protected by a down_read on
68  * mmap_sem.
69  *
70  * Freeing policy:
71  * Mempolicy objects are reference counted.  A mempolicy will be freed when
72  * mpol_free() decrements the reference count to zero.
73  *
74  * Copying policy objects:
75  * mpol_copy() allocates a new mempolicy and copies the specified mempolicy
76  * to the new storage.  The reference count of the new object is initialized
77  * to 1, representing the caller of mpol_copy().
78  */
79 struct mempolicy {
80         atomic_t refcnt;
81         unsigned short policy;  /* See MPOL_* above */
82         unsigned short flags;   /* See set_mempolicy() MPOL_F_* above */
83         union {
84                 short            preferred_node; /* preferred */
85                 nodemask_t       nodes;         /* interleave/bind */
86                 /* undefined for default */
87         } v;
88         nodemask_t cpuset_mems_allowed; /* mempolicy relative to these nodes */
89 };
90
91 /*
92  * Support for managing mempolicy data objects (clone, copy, destroy)
93  * The default fast path of a NULL MPOL_DEFAULT policy is always inlined.
94  */
95
96 extern void __mpol_free(struct mempolicy *pol);
97 static inline void mpol_free(struct mempolicy *pol)
98 {
99         if (pol)
100                 __mpol_free(pol);
101 }
102
103 extern struct mempolicy *__mpol_copy(struct mempolicy *pol);
104 static inline struct mempolicy *mpol_copy(struct mempolicy *pol)
105 {
106         if (pol)
107                 pol = __mpol_copy(pol);
108         return pol;
109 }
110
111 #define vma_policy(vma) ((vma)->vm_policy)
112 #define vma_set_policy(vma, pol) ((vma)->vm_policy = (pol))
113
114 static inline void mpol_get(struct mempolicy *pol)
115 {
116         if (pol)
117                 atomic_inc(&pol->refcnt);
118 }
119
120 extern int __mpol_equal(struct mempolicy *a, struct mempolicy *b);
121 static inline int mpol_equal(struct mempolicy *a, struct mempolicy *b)
122 {
123         if (a == b)
124                 return 1;
125         return __mpol_equal(a, b);
126 }
127 #define vma_mpol_equal(a,b) mpol_equal(vma_policy(a), vma_policy(b))
128
129 /* Could later add inheritance of the process policy here. */
130
131 #define mpol_set_vma_default(vma) ((vma)->vm_policy = NULL)
132
133 /*
134  * Tree of shared policies for a shared memory region.
135  * Maintain the policies in a pseudo mm that contains vmas. The vmas
136  * carry the policy. As a special twist the pseudo mm is indexed in pages, not
137  * bytes, so that we can work with shared memory segments bigger than
138  * unsigned long.
139  */
140
141 struct sp_node {
142         struct rb_node nd;
143         unsigned long start, end;
144         struct mempolicy *policy;
145 };
146
147 struct shared_policy {
148         struct rb_root root;
149         spinlock_t lock;
150 };
151
152 void mpol_shared_policy_init(struct shared_policy *info, unsigned short policy,
153                                 unsigned short flags, nodemask_t *nodes);
154 int mpol_set_shared_policy(struct shared_policy *info,
155                                 struct vm_area_struct *vma,
156                                 struct mempolicy *new);
157 void mpol_free_shared_policy(struct shared_policy *p);
158 struct mempolicy *mpol_shared_policy_lookup(struct shared_policy *sp,
159                                             unsigned long idx);
160
161 extern void numa_default_policy(void);
162 extern void numa_policy_init(void);
163 extern void mpol_rebind_task(struct task_struct *tsk,
164                                         const nodemask_t *new);
165 extern void mpol_rebind_mm(struct mm_struct *mm, nodemask_t *new);
166 extern void mpol_fix_fork_child_flag(struct task_struct *p);
167
168 extern struct mempolicy default_policy;
169 extern struct zonelist *huge_zonelist(struct vm_area_struct *vma,
170                                 unsigned long addr, gfp_t gfp_flags,
171                                 struct mempolicy **mpol, nodemask_t **nodemask);
172 extern unsigned slab_node(struct mempolicy *policy);
173
174 extern enum zone_type policy_zone;
175
176 static inline void check_highest_zone(enum zone_type k)
177 {
178         if (k > policy_zone && k != ZONE_MOVABLE)
179                 policy_zone = k;
180 }
181
182 int do_migrate_pages(struct mm_struct *mm,
183         const nodemask_t *from_nodes, const nodemask_t *to_nodes, int flags);
184
185 #else
186
187 struct mempolicy {};
188
189 static inline int mpol_equal(struct mempolicy *a, struct mempolicy *b)
190 {
191         return 1;
192 }
193 #define vma_mpol_equal(a,b) 1
194
195 #define mpol_set_vma_default(vma) do {} while(0)
196
197 static inline void mpol_free(struct mempolicy *p)
198 {
199 }
200
201 static inline void mpol_get(struct mempolicy *pol)
202 {
203 }
204
205 static inline struct mempolicy *mpol_copy(struct mempolicy *old)
206 {
207         return NULL;
208 }
209
210 struct shared_policy {};
211
212 static inline int mpol_set_shared_policy(struct shared_policy *info,
213                                         struct vm_area_struct *vma,
214                                         struct mempolicy *new)
215 {
216         return -EINVAL;
217 }
218
219 static inline void mpol_shared_policy_init(struct shared_policy *info,
220                 unsigned short policy, unsigned short flags, nodemask_t *nodes)
221 {
222 }
223
224 static inline void mpol_free_shared_policy(struct shared_policy *p)
225 {
226 }
227
228 static inline struct mempolicy *
229 mpol_shared_policy_lookup(struct shared_policy *sp, unsigned long idx)
230 {
231         return NULL;
232 }
233
234 #define vma_policy(vma) NULL
235 #define vma_set_policy(vma, pol) do {} while(0)
236
237 static inline void numa_policy_init(void)
238 {
239 }
240
241 static inline void numa_default_policy(void)
242 {
243 }
244
245 static inline void mpol_rebind_task(struct task_struct *tsk,
246                                         const nodemask_t *new)
247 {
248 }
249
250 static inline void mpol_rebind_mm(struct mm_struct *mm, nodemask_t *new)
251 {
252 }
253
254 static inline void mpol_fix_fork_child_flag(struct task_struct *p)
255 {
256 }
257
258 static inline struct zonelist *huge_zonelist(struct vm_area_struct *vma,
259                                 unsigned long addr, gfp_t gfp_flags,
260                                 struct mempolicy **mpol, nodemask_t **nodemask)
261 {
262         *mpol = NULL;
263         *nodemask = NULL;
264         return node_zonelist(0, gfp_flags);
265 }
266
267 static inline int do_migrate_pages(struct mm_struct *mm,
268                         const nodemask_t *from_nodes,
269                         const nodemask_t *to_nodes, int flags)
270 {
271         return 0;
272 }
273
274 static inline void check_highest_zone(int k)
275 {
276 }
277 #endif /* CONFIG_NUMA */
278 #endif /* __KERNEL__ */
279
280 #endif