[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / linux / mempolicy.h
blob58385ee1c0acc309aa862eab5f7b207110942f27
1 #ifndef _LINUX_MEMPOLICY_H
2 #define _LINUX_MEMPOLICY_H 1
4 #include <linux/errno.h>
6 /*
7 * NUMA memory policies for Linux.
8 * Copyright 2003,2004 Andi Kleen SuSE Labs
9 */
11 /* Policies */
12 #define MPOL_DEFAULT 0
13 #define MPOL_PREFERRED 1
14 #define MPOL_BIND 2
15 #define MPOL_INTERLEAVE 3
17 #define MPOL_MAX MPOL_INTERLEAVE
19 /* Flags for get_mem_policy */
20 #define MPOL_F_NODE (1<<0) /* return next IL mode instead of node mask */
21 #define MPOL_F_ADDR (1<<1) /* look up vma using address */
23 /* Flags for mbind */
24 #define MPOL_MF_STRICT (1<<0) /* Verify existing pages in the mapping */
26 #ifdef __KERNEL__
28 #include <linux/config.h>
29 #include <linux/mmzone.h>
30 #include <linux/bitmap.h>
31 #include <linux/slab.h>
32 #include <linux/rbtree.h>
33 #include <linux/spinlock.h>
35 struct vm_area_struct;
37 #ifdef CONFIG_NUMA
40 * Describe a memory policy.
42 * A mempolicy can be either associated with a process or with a VMA.
43 * For VMA related allocations the VMA policy is preferred, otherwise
44 * the process policy is used. Interrupts ignore the memory policy
45 * of the current process.
47 * Locking policy for interlave:
48 * In process context there is no locking because only the process accesses
49 * its own state. All vma manipulation is somewhat protected by a down_read on
50 * mmap_sem. For allocating in the interleave policy the page_table_lock
51 * must be also aquired to protect il_next.
53 * Freeing policy:
54 * When policy is MPOL_BIND v.zonelist is kmalloc'ed and must be kfree'd.
55 * All other policies don't have any external state. mpol_free() handles this.
57 * Copying policy objects:
58 * For MPOL_BIND the zonelist must be always duplicated. mpol_clone() does this.
60 struct mempolicy {
61 atomic_t refcnt;
62 short policy; /* See MPOL_* above */
63 union {
64 struct zonelist *zonelist; /* bind */
65 short preferred_node; /* preferred */
66 DECLARE_BITMAP(nodes, MAX_NUMNODES); /* interleave */
67 /* undefined for default */
68 } v;
72 * Support for managing mempolicy data objects (clone, copy, destroy)
73 * The default fast path of a NULL MPOL_DEFAULT policy is always inlined.
76 extern void __mpol_free(struct mempolicy *pol);
77 static inline void mpol_free(struct mempolicy *pol)
79 if (pol)
80 __mpol_free(pol);
83 extern struct mempolicy *__mpol_copy(struct mempolicy *pol);
84 static inline struct mempolicy *mpol_copy(struct mempolicy *pol)
86 if (pol)
87 pol = __mpol_copy(pol);
88 return pol;
91 #define vma_policy(vma) ((vma)->vm_policy)
92 #define vma_set_policy(vma, pol) ((vma)->vm_policy = (pol))
94 static inline void mpol_get(struct mempolicy *pol)
96 if (pol)
97 atomic_inc(&pol->refcnt);
100 extern int __mpol_equal(struct mempolicy *a, struct mempolicy *b);
101 static inline int mpol_equal(struct mempolicy *a, struct mempolicy *b)
103 if (a == b)
104 return 1;
105 return __mpol_equal(a, b);
107 #define vma_mpol_equal(a,b) mpol_equal(vma_policy(a), vma_policy(b))
109 /* Could later add inheritance of the process policy here. */
111 #define mpol_set_vma_default(vma) ((vma)->vm_policy = NULL)
114 * Hugetlb policy. i386 hugetlb so far works with node numbers
115 * instead of zone lists, so give it special interfaces for now.
117 extern int mpol_first_node(struct vm_area_struct *vma, unsigned long addr);
118 extern int mpol_node_valid(int nid, struct vm_area_struct *vma,
119 unsigned long addr);
122 * Tree of shared policies for a shared memory region.
123 * Maintain the policies in a pseudo mm that contains vmas. The vmas
124 * carry the policy. As a special twist the pseudo mm is indexed in pages, not
125 * bytes, so that we can work with shared memory segments bigger than
126 * unsigned long.
129 struct sp_node {
130 struct rb_node nd;
131 unsigned long start, end;
132 struct mempolicy *policy;
135 struct shared_policy {
136 struct rb_root root;
137 spinlock_t lock;
140 static inline void mpol_shared_policy_init(struct shared_policy *info)
142 info->root = RB_ROOT;
143 spin_lock_init(&info->lock);
146 int mpol_set_shared_policy(struct shared_policy *info,
147 struct vm_area_struct *vma,
148 struct mempolicy *new);
149 void mpol_free_shared_policy(struct shared_policy *p);
150 struct mempolicy *mpol_shared_policy_lookup(struct shared_policy *sp,
151 unsigned long idx);
153 struct mempolicy *get_vma_policy(struct task_struct *task,
154 struct vm_area_struct *vma, unsigned long addr);
156 extern void numa_default_policy(void);
157 extern void numa_policy_init(void);
158 extern struct mempolicy default_policy;
160 #else
162 struct mempolicy {};
164 static inline int mpol_equal(struct mempolicy *a, struct mempolicy *b)
166 return 1;
168 #define vma_mpol_equal(a,b) 1
170 #define mpol_set_vma_default(vma) do {} while(0)
172 static inline void mpol_free(struct mempolicy *p)
176 static inline void mpol_get(struct mempolicy *pol)
180 static inline struct mempolicy *mpol_copy(struct mempolicy *old)
182 return NULL;
185 static inline int mpol_first_node(struct vm_area_struct *vma, unsigned long a)
187 return numa_node_id();
190 static inline int
191 mpol_node_valid(int nid, struct vm_area_struct *vma, unsigned long a)
193 return 1;
196 struct shared_policy {};
198 static inline int mpol_set_shared_policy(struct shared_policy *info,
199 struct vm_area_struct *vma,
200 struct mempolicy *new)
202 return -EINVAL;
205 static inline void mpol_shared_policy_init(struct shared_policy *info)
209 static inline void mpol_free_shared_policy(struct shared_policy *p)
213 static inline struct mempolicy *
214 mpol_shared_policy_lookup(struct shared_policy *sp, unsigned long idx)
216 return NULL;
219 #define vma_policy(vma) NULL
220 #define vma_set_policy(vma, pol) do {} while(0)
222 static inline void numa_policy_init(void)
226 static inline void numa_default_policy(void)
230 #endif /* CONFIG_NUMA */
231 #endif /* __KERNEL__ */
233 #endif