nlm: Ensure callback code also checks that the files match
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / gfp.h
CommitLineData
1da177e4
LT
1#ifndef __LINUX_GFP_H
2#define __LINUX_GFP_H
3
4#include <linux/mmzone.h>
5#include <linux/stddef.h>
6#include <linux/linkage.h>
082edb7b 7#include <linux/topology.h>
6484eb3e 8#include <linux/mmdebug.h>
1da177e4
LT
9
10struct vm_area_struct;
11
16b56cf4
NK
12/* Plain integer GFP bitmasks. Do not use this directly. */
13#define ___GFP_DMA 0x01u
14#define ___GFP_HIGHMEM 0x02u
15#define ___GFP_DMA32 0x04u
16#define ___GFP_MOVABLE 0x08u
17#define ___GFP_WAIT 0x10u
18#define ___GFP_HIGH 0x20u
19#define ___GFP_IO 0x40u
20#define ___GFP_FS 0x80u
21#define ___GFP_COLD 0x100u
22#define ___GFP_NOWARN 0x200u
23#define ___GFP_REPEAT 0x400u
24#define ___GFP_NOFAIL 0x800u
25#define ___GFP_NORETRY 0x1000u
b37f1dd0 26#define ___GFP_MEMALLOC 0x2000u
16b56cf4
NK
27#define ___GFP_COMP 0x4000u
28#define ___GFP_ZERO 0x8000u
29#define ___GFP_NOMEMALLOC 0x10000u
30#define ___GFP_HARDWALL 0x20000u
31#define ___GFP_THISNODE 0x40000u
32#define ___GFP_RECLAIMABLE 0x80000u
7a64bf05 33#define ___GFP_KMEMCG 0x100000u
caf49191
LT
34#define ___GFP_NOTRACK 0x200000u
35#define ___GFP_NO_KSWAPD 0x400000u
36#define ___GFP_OTHER_NODE 0x800000u
37#define ___GFP_WRITE 0x1000000u
05b0afd7 38/* If the above are modified, __GFP_BITS_SHIFT may need updating */
16b56cf4 39
1da177e4
LT
40/*
41 * GFP bitmasks..
e53ef38d
CL
42 *
43 * Zone modifiers (see linux/mmzone.h - low three bits)
44 *
e53ef38d 45 * Do not put any conditional on these. If necessary modify the definitions
263ff5d8 46 * without the underscores and use them consistently. The definitions here may
e53ef38d 47 * be used in bit comparisons.
1da177e4 48 */
16b56cf4
NK
49#define __GFP_DMA ((__force gfp_t)___GFP_DMA)
50#define __GFP_HIGHMEM ((__force gfp_t)___GFP_HIGHMEM)
51#define __GFP_DMA32 ((__force gfp_t)___GFP_DMA32)
52#define __GFP_MOVABLE ((__force gfp_t)___GFP_MOVABLE) /* Page is movable */
b70d94ee 53#define GFP_ZONEMASK (__GFP_DMA|__GFP_HIGHMEM|__GFP_DMA32|__GFP_MOVABLE)
1da177e4
LT
54/*
55 * Action modifiers - doesn't change the zoning
56 *
57 * __GFP_REPEAT: Try hard to allocate the memory, but the allocation attempt
58 * _might_ fail. This depends upon the particular VM implementation.
59 *
60 * __GFP_NOFAIL: The VM implementation _must_ retry infinitely: the caller
478352e7
DR
61 * cannot handle allocation failures. This modifier is deprecated and no new
62 * users should be added.
1da177e4
LT
63 *
64 * __GFP_NORETRY: The VM implementation must not retry indefinitely.
769848c0
MG
65 *
66 * __GFP_MOVABLE: Flag that this page will be movable by the page migration
67 * mechanism or reclaimed
1da177e4 68 */
16b56cf4
NK
69#define __GFP_WAIT ((__force gfp_t)___GFP_WAIT) /* Can wait and reschedule? */
70#define __GFP_HIGH ((__force gfp_t)___GFP_HIGH) /* Should access emergency pools? */
71#define __GFP_IO ((__force gfp_t)___GFP_IO) /* Can start physical IO? */
72#define __GFP_FS ((__force gfp_t)___GFP_FS) /* Can call down to low-level FS? */
73#define __GFP_COLD ((__force gfp_t)___GFP_COLD) /* Cache-cold page required */
74#define __GFP_NOWARN ((__force gfp_t)___GFP_NOWARN) /* Suppress page allocation failure warning */
75#define __GFP_REPEAT ((__force gfp_t)___GFP_REPEAT) /* See above */
76#define __GFP_NOFAIL ((__force gfp_t)___GFP_NOFAIL) /* See above */
77#define __GFP_NORETRY ((__force gfp_t)___GFP_NORETRY) /* See above */
b37f1dd0 78#define __GFP_MEMALLOC ((__force gfp_t)___GFP_MEMALLOC)/* Allow access to emergency reserves */
16b56cf4
NK
79#define __GFP_COMP ((__force gfp_t)___GFP_COMP) /* Add compound page metadata */
80#define __GFP_ZERO ((__force gfp_t)___GFP_ZERO) /* Return zeroed page on success */
b37f1dd0
MG
81#define __GFP_NOMEMALLOC ((__force gfp_t)___GFP_NOMEMALLOC) /* Don't use emergency reserves.
82 * This takes precedence over the
83 * __GFP_MEMALLOC flag if both are
84 * set
85 */
16b56cf4
NK
86#define __GFP_HARDWALL ((__force gfp_t)___GFP_HARDWALL) /* Enforce hardwall cpuset memory allocs */
87#define __GFP_THISNODE ((__force gfp_t)___GFP_THISNODE)/* No fallback, no policies */
88#define __GFP_RECLAIMABLE ((__force gfp_t)___GFP_RECLAIMABLE) /* Page is reclaimable */
89#define __GFP_NOTRACK ((__force gfp_t)___GFP_NOTRACK) /* Don't track with kmemcheck */
1da177e4 90
caf49191 91#define __GFP_NO_KSWAPD ((__force gfp_t)___GFP_NO_KSWAPD)
78afd561 92#define __GFP_OTHER_NODE ((__force gfp_t)___GFP_OTHER_NODE) /* On behalf of other node */
7a64bf05 93#define __GFP_KMEMCG ((__force gfp_t)___GFP_KMEMCG) /* Allocation comes from a memcg-accounted resource */
a756cf59 94#define __GFP_WRITE ((__force gfp_t)___GFP_WRITE) /* Allocator intends to dirty page */
32dba98e 95
2dff4405
VN
96/*
97 * This may seem redundant, but it's a way of annotating false positives vs.
98 * allocations that simply cannot be supported (e.g. page tables).
99 */
100#define __GFP_NOTRACK_FALSE_POSITIVE (__GFP_NOTRACK)
101
caf49191 102#define __GFP_BITS_SHIFT 25 /* Room for N __GFP_FOO bits */
af4ca457 103#define __GFP_BITS_MASK ((__force gfp_t)((1 << __GFP_BITS_SHIFT) - 1))
1da177e4 104
7b04d717
JD
105/* This equals 0, but use constants in case they ever change */
106#define GFP_NOWAIT (GFP_ATOMIC & ~__GFP_HIGH)
4eac915d 107/* GFP_ATOMIC means both !wait (__GFP_WAIT not set) and use emergency pool */
1da177e4
LT
108#define GFP_ATOMIC (__GFP_HIGH)
109#define GFP_NOIO (__GFP_WAIT)
110#define GFP_NOFS (__GFP_WAIT | __GFP_IO)
111#define GFP_KERNEL (__GFP_WAIT | __GFP_IO | __GFP_FS)
e12ba74d
MG
112#define GFP_TEMPORARY (__GFP_WAIT | __GFP_IO | __GFP_FS | \
113 __GFP_RECLAIMABLE)
f90b1d2f
PJ
114#define GFP_USER (__GFP_WAIT | __GFP_IO | __GFP_FS | __GFP_HARDWALL)
115#define GFP_HIGHUSER (__GFP_WAIT | __GFP_IO | __GFP_FS | __GFP_HARDWALL | \
116 __GFP_HIGHMEM)
769848c0
MG
117#define GFP_HIGHUSER_MOVABLE (__GFP_WAIT | __GFP_IO | __GFP_FS | \
118 __GFP_HARDWALL | __GFP_HIGHMEM | \
119 __GFP_MOVABLE)
452aa699 120#define GFP_IOFS (__GFP_IO | __GFP_FS)
71e3aac0 121#define GFP_TRANSHUGE (GFP_HIGHUSER_MOVABLE | __GFP_COMP | \
caf49191
LT
122 __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN | \
123 __GFP_NO_KSWAPD)
1da177e4 124
77f700da 125#ifdef CONFIG_NUMA
980128f2 126#define GFP_THISNODE (__GFP_THISNODE | __GFP_NOWARN | __GFP_NORETRY)
77f700da 127#else
f2e97df6 128#define GFP_THISNODE ((__force gfp_t)0)
77f700da
CL
129#endif
130
6cb06229 131/* This mask makes up all the page movable related flags */
e12ba74d 132#define GFP_MOVABLE_MASK (__GFP_RECLAIMABLE|__GFP_MOVABLE)
6cb06229
CL
133
134/* Control page allocator reclaim behavior */
135#define GFP_RECLAIM_MASK (__GFP_WAIT|__GFP_HIGH|__GFP_IO|__GFP_FS|\
136 __GFP_NOWARN|__GFP_REPEAT|__GFP_NOFAIL|\
b37f1dd0 137 __GFP_NORETRY|__GFP_MEMALLOC|__GFP_NOMEMALLOC)
6cb06229 138
7e85ee0c 139/* Control slab gfp mask during early boot */
fd23855e 140#define GFP_BOOT_MASK (__GFP_BITS_MASK & ~(__GFP_WAIT|__GFP_IO|__GFP_FS))
7e85ee0c 141
6cb06229
CL
142/* Control allocation constraints */
143#define GFP_CONSTRAINT_MASK (__GFP_HARDWALL|__GFP_THISNODE)
144
145/* Do not use these with a slab allocator */
146#define GFP_SLAB_BUG_MASK (__GFP_DMA32|__GFP_HIGHMEM|~__GFP_BITS_MASK)
980128f2 147
1da177e4
LT
148/* Flag - indicates that the buffer will be suitable for DMA. Ignored on some
149 platforms, used as appropriate on others */
150
151#define GFP_DMA __GFP_DMA
152
a2f1b424
AK
153/* 4GB DMA on some platforms */
154#define GFP_DMA32 __GFP_DMA32
155
467c996c
MG
156/* Convert GFP flags to their corresponding migrate type */
157static inline int allocflags_to_migratetype(gfp_t gfp_flags)
158{
159 WARN_ON((gfp_flags & GFP_MOVABLE_MASK) == GFP_MOVABLE_MASK);
160
161 if (unlikely(page_group_by_mobility_disabled))
162 return MIGRATE_UNMOVABLE;
163
164 /* Group based on mobility */
165 return (((gfp_flags & __GFP_MOVABLE) != 0) << 1) |
166 ((gfp_flags & __GFP_RECLAIMABLE) != 0);
167}
a2f1b424 168
b70d94ee
CL
169#ifdef CONFIG_HIGHMEM
170#define OPT_ZONE_HIGHMEM ZONE_HIGHMEM
171#else
172#define OPT_ZONE_HIGHMEM ZONE_NORMAL
173#endif
174
4b51d669 175#ifdef CONFIG_ZONE_DMA
b70d94ee
CL
176#define OPT_ZONE_DMA ZONE_DMA
177#else
178#define OPT_ZONE_DMA ZONE_NORMAL
4b51d669 179#endif
b70d94ee 180
4e4785bc 181#ifdef CONFIG_ZONE_DMA32
b70d94ee
CL
182#define OPT_ZONE_DMA32 ZONE_DMA32
183#else
184#define OPT_ZONE_DMA32 ZONE_NORMAL
4e4785bc 185#endif
b70d94ee
CL
186
187/*
188 * GFP_ZONE_TABLE is a word size bitstring that is used for looking up the
189 * zone to use given the lowest 4 bits of gfp_t. Entries are ZONE_SHIFT long
190 * and there are 16 of them to cover all possible combinations of
263ff5d8 191 * __GFP_DMA, __GFP_DMA32, __GFP_MOVABLE and __GFP_HIGHMEM.
b70d94ee
CL
192 *
193 * The zone fallback order is MOVABLE=>HIGHMEM=>NORMAL=>DMA32=>DMA.
194 * But GFP_MOVABLE is not only a zone specifier but also an allocation
195 * policy. Therefore __GFP_MOVABLE plus another zone selector is valid.
263ff5d8 196 * Only 1 bit of the lowest 3 bits (DMA,DMA32,HIGHMEM) can be set to "1".
b70d94ee
CL
197 *
198 * bit result
199 * =================
200 * 0x0 => NORMAL
201 * 0x1 => DMA or NORMAL
202 * 0x2 => HIGHMEM or NORMAL
203 * 0x3 => BAD (DMA+HIGHMEM)
204 * 0x4 => DMA32 or DMA or NORMAL
205 * 0x5 => BAD (DMA+DMA32)
206 * 0x6 => BAD (HIGHMEM+DMA32)
207 * 0x7 => BAD (HIGHMEM+DMA32+DMA)
208 * 0x8 => NORMAL (MOVABLE+0)
209 * 0x9 => DMA or NORMAL (MOVABLE+DMA)
210 * 0xa => MOVABLE (Movable is valid only if HIGHMEM is set too)
211 * 0xb => BAD (MOVABLE+HIGHMEM+DMA)
212 * 0xc => DMA32 (MOVABLE+HIGHMEM+DMA32)
213 * 0xd => BAD (MOVABLE+DMA32+DMA)
214 * 0xe => BAD (MOVABLE+DMA32+HIGHMEM)
215 * 0xf => BAD (MOVABLE+DMA32+HIGHMEM+DMA)
216 *
217 * ZONES_SHIFT must be <= 2 on 32 bit platforms.
218 */
219
220#if 16 * ZONES_SHIFT > BITS_PER_LONG
221#error ZONES_SHIFT too large to create GFP_ZONE_TABLE integer
222#endif
223
224#define GFP_ZONE_TABLE ( \
16b56cf4
NK
225 (ZONE_NORMAL << 0 * ZONES_SHIFT) \
226 | (OPT_ZONE_DMA << ___GFP_DMA * ZONES_SHIFT) \
227 | (OPT_ZONE_HIGHMEM << ___GFP_HIGHMEM * ZONES_SHIFT) \
228 | (OPT_ZONE_DMA32 << ___GFP_DMA32 * ZONES_SHIFT) \
229 | (ZONE_NORMAL << ___GFP_MOVABLE * ZONES_SHIFT) \
230 | (OPT_ZONE_DMA << (___GFP_MOVABLE | ___GFP_DMA) * ZONES_SHIFT) \
231 | (ZONE_MOVABLE << (___GFP_MOVABLE | ___GFP_HIGHMEM) * ZONES_SHIFT) \
232 | (OPT_ZONE_DMA32 << (___GFP_MOVABLE | ___GFP_DMA32) * ZONES_SHIFT) \
b70d94ee
CL
233)
234
235/*
263ff5d8 236 * GFP_ZONE_BAD is a bitmap for all combinations of __GFP_DMA, __GFP_DMA32
b70d94ee
CL
237 * __GFP_HIGHMEM and __GFP_MOVABLE that are not permitted. One flag per
238 * entry starting with bit 0. Bit is set if the combination is not
239 * allowed.
240 */
241#define GFP_ZONE_BAD ( \
16b56cf4
NK
242 1 << (___GFP_DMA | ___GFP_HIGHMEM) \
243 | 1 << (___GFP_DMA | ___GFP_DMA32) \
244 | 1 << (___GFP_DMA32 | ___GFP_HIGHMEM) \
245 | 1 << (___GFP_DMA | ___GFP_DMA32 | ___GFP_HIGHMEM) \
246 | 1 << (___GFP_MOVABLE | ___GFP_HIGHMEM | ___GFP_DMA) \
247 | 1 << (___GFP_MOVABLE | ___GFP_DMA32 | ___GFP_DMA) \
248 | 1 << (___GFP_MOVABLE | ___GFP_DMA32 | ___GFP_HIGHMEM) \
249 | 1 << (___GFP_MOVABLE | ___GFP_DMA32 | ___GFP_DMA | ___GFP_HIGHMEM) \
b70d94ee
CL
250)
251
252static inline enum zone_type gfp_zone(gfp_t flags)
253{
254 enum zone_type z;
16b56cf4 255 int bit = (__force int) (flags & GFP_ZONEMASK);
b70d94ee
CL
256
257 z = (GFP_ZONE_TABLE >> (bit * ZONES_SHIFT)) &
258 ((1 << ZONES_SHIFT) - 1);
82d4b577 259 VM_BUG_ON((GFP_ZONE_BAD >> bit) & 1);
b70d94ee 260 return z;
4e4785bc
CL
261}
262
1da177e4
LT
263/*
264 * There is only one page-allocator function, and two main namespaces to
265 * it. The alloc_page*() variants return 'struct page *' and as such
266 * can allocate highmem pages, the *get*page*() variants return
267 * virtual kernel addresses to the allocated page(s).
268 */
269
54a6eb5c
MG
270static inline int gfp_zonelist(gfp_t flags)
271{
e5adfffc 272 if (IS_ENABLED(CONFIG_NUMA) && unlikely(flags & __GFP_THISNODE))
54a6eb5c
MG
273 return 1;
274
275 return 0;
276}
277
1da177e4
LT
278/*
279 * We get the zone list from the current node and the gfp_mask.
280 * This zone list contains a maximum of MAXNODES*MAX_NR_ZONES zones.
54a6eb5c
MG
281 * There are two zonelists per node, one for all zones with memory and
282 * one containing just zones from the node the zonelist belongs to.
1da177e4
LT
283 *
284 * For the normal case of non-DISCONTIGMEM systems the NODE_DATA() gets
285 * optimized to &contig_page_data at compile-time.
286 */
0e88460d
MG
287static inline struct zonelist *node_zonelist(int nid, gfp_t flags)
288{
54a6eb5c 289 return NODE_DATA(nid)->node_zonelists + gfp_zonelist(flags);
0e88460d 290}
1da177e4
LT
291
292#ifndef HAVE_ARCH_FREE_PAGE
293static inline void arch_free_page(struct page *page, int order) { }
294#endif
cc102509
NP
295#ifndef HAVE_ARCH_ALLOC_PAGE
296static inline void arch_alloc_page(struct page *page, int order) { }
297#endif
1da177e4 298
e4048e5d 299struct page *
d239171e 300__alloc_pages_nodemask(gfp_t gfp_mask, unsigned int order,
e4048e5d
KM
301 struct zonelist *zonelist, nodemask_t *nodemask);
302
303static inline struct page *
304__alloc_pages(gfp_t gfp_mask, unsigned int order,
305 struct zonelist *zonelist)
306{
d239171e 307 return __alloc_pages_nodemask(gfp_mask, order, zonelist, NULL);
e4048e5d
KM
308}
309
dd0fc66f 310static inline struct page *alloc_pages_node(int nid, gfp_t gfp_mask,
1da177e4
LT
311 unsigned int order)
312{
819a6928
AK
313 /* Unknown node is current node */
314 if (nid < 0)
315 nid = numa_node_id();
316
0e88460d 317 return __alloc_pages(gfp_mask, order, node_zonelist(nid, gfp_mask));
1da177e4
LT
318}
319
6484eb3e
MG
320static inline struct page *alloc_pages_exact_node(int nid, gfp_t gfp_mask,
321 unsigned int order)
322{
f6d7e0cb 323 VM_BUG_ON(nid < 0 || nid >= MAX_NUMNODES || !node_online(nid));
6484eb3e
MG
324
325 return __alloc_pages(gfp_mask, order, node_zonelist(nid, gfp_mask));
326}
327
1da177e4 328#ifdef CONFIG_NUMA
dd0fc66f 329extern struct page *alloc_pages_current(gfp_t gfp_mask, unsigned order);
1da177e4
LT
330
331static inline struct page *
dd0fc66f 332alloc_pages(gfp_t gfp_mask, unsigned int order)
1da177e4 333{
1da177e4
LT
334 return alloc_pages_current(gfp_mask, order);
335}
0bbbc0b3 336extern struct page *alloc_pages_vma(gfp_t gfp_mask, int order,
2f5f9486
AK
337 struct vm_area_struct *vma, unsigned long addr,
338 int node);
1da177e4
LT
339#else
340#define alloc_pages(gfp_mask, order) \
341 alloc_pages_node(numa_node_id(), gfp_mask, order)
2f5f9486 342#define alloc_pages_vma(gfp_mask, order, vma, addr, node) \
0bbbc0b3 343 alloc_pages(gfp_mask, order)
1da177e4
LT
344#endif
345#define alloc_page(gfp_mask) alloc_pages(gfp_mask, 0)
2f5f9486
AK
346#define alloc_page_vma(gfp_mask, vma, addr) \
347 alloc_pages_vma(gfp_mask, 0, vma, addr, numa_node_id())
236344d6
AK
348#define alloc_page_vma_node(gfp_mask, vma, addr, node) \
349 alloc_pages_vma(gfp_mask, 0, vma, addr, node)
1da177e4 350
b3c97528
HH
351extern unsigned long __get_free_pages(gfp_t gfp_mask, unsigned int order);
352extern unsigned long get_zeroed_page(gfp_t gfp_mask);
1da177e4 353
2be0ffe2
TT
354void *alloc_pages_exact(size_t size, gfp_t gfp_mask);
355void free_pages_exact(void *virt, size_t size);
ee85c2e1
AK
356/* This is different from alloc_pages_exact_node !!! */
357void *alloc_pages_exact_nid(int nid, size_t size, gfp_t gfp_mask);
2be0ffe2 358
1da177e4 359#define __get_free_page(gfp_mask) \
fd23855e 360 __get_free_pages((gfp_mask), 0)
1da177e4
LT
361
362#define __get_dma_pages(gfp_mask, order) \
fd23855e 363 __get_free_pages((gfp_mask) | GFP_DMA, (order))
1da177e4 364
b3c97528
HH
365extern void __free_pages(struct page *page, unsigned int order);
366extern void free_pages(unsigned long addr, unsigned int order);
fc91668e 367extern void free_hot_cold_page(struct page *page, int cold);
cc59850e 368extern void free_hot_cold_page_list(struct list_head *list, int cold);
1da177e4 369
6a1a0d3b
GC
370extern void __free_memcg_kmem_pages(struct page *page, unsigned int order);
371extern void free_memcg_kmem_pages(unsigned long addr, unsigned int order);
372
1da177e4 373#define __free_page(page) __free_pages((page), 0)
fd23855e 374#define free_page(addr) free_pages((addr), 0)
1da177e4
LT
375
376void page_alloc_init(void);
4037d452 377void drain_zone_pages(struct zone *zone, struct per_cpu_pages *pcp);
9f8f2172
CL
378void drain_all_pages(void);
379void drain_local_pages(void *dummy);
1da177e4 380
f90ac398
MG
381/*
382 * gfp_allowed_mask is set to GFP_BOOT_MASK during early boot to restrict what
383 * GFP flags are used before interrupts are enabled. Once interrupts are
384 * enabled, it is set to __GFP_BITS_MASK while the system is running. During
385 * hibernation, it is used by PM to avoid I/O during memory allocation while
386 * devices are suspended.
387 */
dcce284a
BH
388extern gfp_t gfp_allowed_mask;
389
c93bdd0e
MG
390/* Returns true if the gfp_mask allows use of ALLOC_NO_WATERMARK */
391bool gfp_pfmemalloc_allowed(gfp_t gfp_mask);
392
c9e664f1
RW
393extern void pm_restrict_gfp_mask(void);
394extern void pm_restore_gfp_mask(void);
dcce284a 395
f90ac398
MG
396#ifdef CONFIG_PM_SLEEP
397extern bool pm_suspended_storage(void);
398#else
399static inline bool pm_suspended_storage(void)
400{
401 return false;
402}
403#endif /* CONFIG_PM_SLEEP */
404
041d3a8c
MN
405#ifdef CONFIG_CMA
406
407/* The below functions must be run on a range from a single zone. */
0815f3d8
MN
408extern int alloc_contig_range(unsigned long start, unsigned long end,
409 unsigned migratetype);
041d3a8c
MN
410extern void free_contig_range(unsigned long pfn, unsigned nr_pages);
411
47118af0
MN
412/* CMA stuff */
413extern void init_cma_reserved_pageblock(struct page *page);
414
041d3a8c
MN
415#endif
416
1da177e4 417#endif /* __LINUX_GFP_H */