mempolicy: rename mpol_free to mpol_put
[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 #define MPOL_F_STATIC_NODES     (1 << 15)
28 #define MPOL_F_RELATIVE_NODES   (1 << 14)
29
30 /*
31  * MPOL_MODE_FLAGS is the union of all possible optional mode flags passed to
32  * either set_mempolicy() or mbind().
33  */
34 #define MPOL_MODE_FLAGS (MPOL_F_STATIC_NODES | MPOL_F_RELATIVE_NODES)
35
36 /* Flags for get_mempolicy */
37 #define MPOL_F_NODE     (1<<0)  /* return next IL mode instead of node mask */
38 #define MPOL_F_ADDR     (1<<1)  /* look up vma using address */
39 #define MPOL_F_MEMS_ALLOWED (1<<2) /* return allowed memories */
40
41 /* Flags for mbind */
42 #define MPOL_MF_STRICT  (1<<0)  /* Verify existing pages in the mapping */
43 #define MPOL_MF_MOVE    (1<<1)  /* Move pages owned by this process to conform to mapping */
44 #define MPOL_MF_MOVE_ALL (1<<2) /* Move every page to conform to mapping */
45 #define MPOL_MF_INTERNAL (1<<3) /* Internal flags start here */
46
47 #ifdef __KERNEL__
48
49 #include <linux/mmzone.h>
50 #include <linux/slab.h>
51 #include <linux/rbtree.h>
52 #include <linux/spinlock.h>
53 #include <linux/nodemask.h>
54
55 struct mm_struct;
56
57 #ifdef CONFIG_NUMA
58
59 /*
60  * Describe a memory policy.
61  *
62  * A mempolicy can be either associated with a process or with a VMA.
63  * For VMA related allocations the VMA policy is preferred, otherwise
64  * the process policy is used. Interrupts ignore the memory policy
65  * of the current process.
66  *
67  * Locking policy for interlave:
68  * In process context there is no locking because only the process accesses
69  * its own state. All vma manipulation is somewhat protected by a down_read on
70  * mmap_sem.
71  *
72  * Freeing policy:
73  * Mempolicy objects are reference counted.  A mempolicy will be freed when
74  * mpol_put() decrements the reference count to zero.
75  *
76  * Copying policy objects:
77  * mpol_copy() allocates a new mempolicy and copies the specified mempolicy
78  * to the new storage.  The reference count of the new object is initialized
79  * to 1, representing the caller of mpol_copy().
80  */
81 struct mempolicy {
82         atomic_t refcnt;
83         unsigned short policy;  /* See MPOL_* above */
84         unsigned short flags;   /* See set_mempolicy() MPOL_F_* above */
85         union {
86                 short            preferred_node; /* preferred */
87                 nodemask_t       nodes;         /* interleave/bind */
88                 /* undefined for default */
89         } v;
90         union {
91                 nodemask_t cpuset_mems_allowed; /* relative to these nodes */
92                 nodemask_t user_nodemask;       /* nodemask passed by user */
93         } w;
94 };
95
96 /*
97  * Support for managing mempolicy data objects (clone, copy, destroy)
98  * The default fast path of a NULL MPOL_DEFAULT policy is always inlined.
99  */
100
101 extern void __mpol_put(struct mempolicy *pol);
102 static inline void mpol_put(struct mempolicy *pol)
103 {
104         if (pol)
105                 __mpol_put(pol);
106 }
107
108 extern struct mempolicy *__mpol_copy(struct mempolicy *pol);
109 static inline struct mempolicy *mpol_copy(struct mempolicy *pol)
110 {
111         if (pol)
112                 pol = __mpol_copy(pol);
113         return pol;
114 }
115
116 #define vma_policy(vma) ((vma)->vm_policy)
117 #define vma_set_policy(vma, pol) ((vma)->vm_policy = (pol))
118
119 static inline void mpol_get(struct mempolicy *pol)
120 {
121         if (pol)
122                 atomic_inc(&pol->refcnt);
123 }
124
125 extern int __mpol_equal(struct mempolicy *a, struct mempolicy *b);
126 static inline int mpol_equal(struct mempolicy *a, struct mempolicy *b)
127 {
128         if (a == b)
129                 return 1;
130         return __mpol_equal(a, b);
131 }
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 zonelist *huge_zonelist(struct vm_area_struct *vma,
169                                 unsigned long addr, gfp_t gfp_flags,
170                                 struct mempolicy **mpol, nodemask_t **nodemask);
171 extern unsigned slab_node(struct mempolicy *policy);
172
173 extern enum zone_type policy_zone;
174
175 static inline void check_highest_zone(enum zone_type k)
176 {
177         if (k > policy_zone && k != ZONE_MOVABLE)
178                 policy_zone = k;
179 }
180
181 int do_migrate_pages(struct mm_struct *mm,
182         const nodemask_t *from_nodes, const nodemask_t *to_nodes, int flags);
183
184 #else
185
186 struct mempolicy {};
187
188 static inline int mpol_equal(struct mempolicy *a, struct mempolicy *b)
189 {
190         return 1;
191 }
192
193 static inline void mpol_put(struct mempolicy *p)
194 {
195 }
196
197 static inline void mpol_get(struct mempolicy *pol)
198 {
199 }
200
201 static inline struct mempolicy *mpol_copy(struct mempolicy *old)
202 {
203         return NULL;
204 }
205
206 struct shared_policy {};
207
208 static inline int mpol_set_shared_policy(struct shared_policy *info,
209                                         struct vm_area_struct *vma,
210                                         struct mempolicy *new)
211 {
212         return -EINVAL;
213 }
214
215 static inline void mpol_shared_policy_init(struct shared_policy *info,
216                 unsigned short policy, unsigned short flags, nodemask_t *nodes)
217 {
218 }
219
220 static inline void mpol_free_shared_policy(struct shared_policy *p)
221 {
222 }
223
224 static inline struct mempolicy *
225 mpol_shared_policy_lookup(struct shared_policy *sp, unsigned long idx)
226 {
227         return NULL;
228 }
229
230 #define vma_policy(vma) NULL
231 #define vma_set_policy(vma, pol) do {} while(0)
232
233 static inline void numa_policy_init(void)
234 {
235 }
236
237 static inline void numa_default_policy(void)
238 {
239 }
240
241 static inline void mpol_rebind_task(struct task_struct *tsk,
242                                         const nodemask_t *new)
243 {
244 }
245
246 static inline void mpol_rebind_mm(struct mm_struct *mm, nodemask_t *new)
247 {
248 }
249
250 static inline void mpol_fix_fork_child_flag(struct task_struct *p)
251 {
252 }
253
254 static inline struct zonelist *huge_zonelist(struct vm_area_struct *vma,
255                                 unsigned long addr, gfp_t gfp_flags,
256                                 struct mempolicy **mpol, nodemask_t **nodemask)
257 {
258         *mpol = NULL;
259         *nodemask = NULL;
260         return node_zonelist(0, gfp_flags);
261 }
262
263 static inline int do_migrate_pages(struct mm_struct *mm,
264                         const nodemask_t *from_nodes,
265                         const nodemask_t *to_nodes, int flags)
266 {
267         return 0;
268 }
269
270 static inline void check_highest_zone(int k)
271 {
272 }
273 #endif /* CONFIG_NUMA */
274 #endif /* __KERNEL__ */
275
276 #endif