]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - mm/internal.h
netfilter: masquerade: attach nat extension if not present
[mirror_ubuntu-artful-kernel.git] / mm / internal.h
CommitLineData
1da177e4
LT
1/* internal.h: mm/ internal definitions
2 *
3 * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
0f8053a5
NP
11#ifndef __MM_INTERNAL_H
12#define __MM_INTERNAL_H
13
29f175d1 14#include <linux/fs.h>
0f8053a5 15#include <linux/mm.h>
e9b61f19 16#include <linux/pagemap.h>
edf14cdb 17#include <linux/tracepoint-defs.h>
1da177e4 18
dd56b046
MG
19/*
20 * The set of flags that only affect watermark checking and reclaim
21 * behaviour. This is used by the MM to obey the caller constraints
22 * about IO, FS and watermark checking while ignoring placement
23 * hints such as HIGHMEM usage.
24 */
25#define GFP_RECLAIM_MASK (__GFP_RECLAIM|__GFP_HIGH|__GFP_IO|__GFP_FS|\
26 __GFP_NOWARN|__GFP_REPEAT|__GFP_NOFAIL|\
e838a45f
MG
27 __GFP_NORETRY|__GFP_MEMALLOC|__GFP_NOMEMALLOC|\
28 __GFP_ATOMIC)
dd56b046
MG
29
30/* The GFP flags allowed during early boot */
31#define GFP_BOOT_MASK (__GFP_BITS_MASK & ~(__GFP_RECLAIM|__GFP_IO|__GFP_FS))
32
33/* Control allocation cpuset and node placement constraints */
34#define GFP_CONSTRAINT_MASK (__GFP_HARDWALL|__GFP_THISNODE)
35
36/* Do not use these with a slab allocator */
37#define GFP_SLAB_BUG_MASK (__GFP_DMA32|__GFP_HIGHMEM|~__GFP_BITS_MASK)
38
62906027
NP
39void page_writeback_init(void);
40
2994302b 41int do_swap_page(struct vm_fault *vmf);
8a966ed7 42
42b77728
JB
43void free_pgtables(struct mmu_gather *tlb, struct vm_area_struct *start_vma,
44 unsigned long floor, unsigned long ceiling);
45
23519073
KS
46static inline bool can_madv_dontneed_vma(struct vm_area_struct *vma)
47{
48 return !(vma->vm_flags & (VM_LOCKED|VM_HUGETLB|VM_PFNMAP));
49}
50
aac45363
MH
51void unmap_page_range(struct mmu_gather *tlb,
52 struct vm_area_struct *vma,
53 unsigned long addr, unsigned long end,
54 struct zap_details *details);
55
29f175d1
FF
56extern int __do_page_cache_readahead(struct address_space *mapping,
57 struct file *filp, pgoff_t offset, unsigned long nr_to_read,
58 unsigned long lookahead_size);
59
60/*
61 * Submit IO for the read-ahead request in file_ra_state.
62 */
63static inline unsigned long ra_submit(struct file_ra_state *ra,
64 struct address_space *mapping, struct file *filp)
65{
66 return __do_page_cache_readahead(mapping, filp,
67 ra->start, ra->size, ra->async_size);
68}
69
7835e98b 70/*
0139aa7b 71 * Turn a non-refcounted page (->_refcount == 0) into refcounted with
7835e98b
NP
72 * a count of one.
73 */
74static inline void set_page_refcounted(struct page *page)
75{
309381fe 76 VM_BUG_ON_PAGE(PageTail(page), page);
fe896d18 77 VM_BUG_ON_PAGE(page_ref_count(page), page);
77a8a788 78 set_page_count(page, 1);
77a8a788
NP
79}
80
03f6462a
HD
81extern unsigned long highest_memmap_pfn;
82
894bc310
LS
83/*
84 * in mm/vmscan.c:
85 */
62695a84 86extern int isolate_lru_page(struct page *page);
894bc310 87extern void putback_lru_page(struct page *page);
599d0c95 88extern bool pgdat_reclaimable(struct pglist_data *pgdat);
62695a84 89
6219049a
BL
90/*
91 * in mm/rmap.c:
92 */
93extern pmd_t *mm_find_pmd(struct mm_struct *mm, unsigned long address);
94
894bc310
LS
95/*
96 * in mm/page_alloc.c
97 */
3c605096 98
1a6d53a1
VB
99/*
100 * Structure for holding the mostly immutable allocation parameters passed
101 * between functions involved in allocations, including the alloc_pages*
102 * family of functions.
103 *
104 * nodemask, migratetype and high_zoneidx are initialized only once in
105 * __alloc_pages_nodemask() and then never change.
106 *
107 * zonelist, preferred_zone and classzone_idx are set first in
108 * __alloc_pages_nodemask() for the fast path, and might be later changed
109 * in __alloc_pages_slowpath(). All other functions pass the whole strucure
110 * by a const pointer.
111 */
112struct alloc_context {
113 struct zonelist *zonelist;
114 nodemask_t *nodemask;
c33d6c06 115 struct zoneref *preferred_zoneref;
1a6d53a1
VB
116 int migratetype;
117 enum zone_type high_zoneidx;
c9ab0c4f 118 bool spread_dirty_pages;
1a6d53a1
VB
119};
120
93ea9964
MG
121#define ac_classzone_idx(ac) zonelist_zone_idx(ac->preferred_zoneref)
122
3c605096
JK
123/*
124 * Locate the struct page for both the matching buddy in our
125 * pair (buddy1) and the combined O(n+1) page they form (page).
126 *
127 * 1) Any buddy B1 will have an order O twin B2 which satisfies
128 * the following equation:
129 * B2 = B1 ^ (1 << O)
130 * For example, if the starting buddy (buddy2) is #8 its order
131 * 1 buddy is #10:
132 * B2 = 8 ^ (1 << 1) = 8 ^ 2 = 10
133 *
134 * 2) Any buddy B will have an order O+1 parent P which
135 * satisfies the following equation:
136 * P = B & ~(1 << O)
137 *
138 * Assumption: *_mem_map is contiguous at least up to MAX_ORDER
139 */
140static inline unsigned long
76741e77 141__find_buddy_pfn(unsigned long page_pfn, unsigned int order)
3c605096 142{
76741e77 143 return page_pfn ^ (1 << order);
3c605096
JK
144}
145
7cf91a98
JK
146extern struct page *__pageblock_pfn_to_page(unsigned long start_pfn,
147 unsigned long end_pfn, struct zone *zone);
148
149static inline struct page *pageblock_pfn_to_page(unsigned long start_pfn,
150 unsigned long end_pfn, struct zone *zone)
151{
152 if (zone->contiguous)
153 return pfn_to_page(start_pfn);
154
155 return __pageblock_pfn_to_page(start_pfn, end_pfn, zone);
156}
157
3c605096 158extern int __isolate_free_page(struct page *page, unsigned int order);
d70ddd7a
MG
159extern void __free_pages_bootmem(struct page *page, unsigned long pfn,
160 unsigned int order);
d00181b9 161extern void prep_compound_page(struct page *page, unsigned int order);
46f24fd8
JK
162extern void post_alloc_hook(struct page *page, unsigned int order,
163 gfp_t gfp_flags);
42aa83cb 164extern int user_min_free_kbytes;
20a0307c 165
ff9543fd
MN
166#if defined CONFIG_COMPACTION || defined CONFIG_CMA
167
168/*
169 * in mm/compaction.c
170 */
171/*
172 * compact_control is used to track pages being migrated and the free pages
173 * they are being migrated to during memory compaction. The free_pfn starts
174 * at the end of a zone and migrate_pfn begins at the start. Movable pages
175 * are moved to the end of a zone during a compaction run and the run
176 * completes when free_pfn <= migrate_pfn
177 */
178struct compact_control {
179 struct list_head freepages; /* List of free pages to migrate to */
180 struct list_head migratepages; /* List of pages being migrated */
181 unsigned long nr_freepages; /* Number of isolated free pages */
182 unsigned long nr_migratepages; /* Number of pages to migrate */
7f354a54
DR
183 unsigned long total_migrate_scanned;
184 unsigned long total_free_scanned;
ff9543fd
MN
185 unsigned long free_pfn; /* isolate_freepages search base */
186 unsigned long migrate_pfn; /* isolate_migratepages search base */
1a16718c 187 unsigned long last_migrated_pfn;/* Not yet flushed page being freed */
e0b9daeb 188 enum migrate_mode mode; /* Async or sync migration mode */
bb13ffeb 189 bool ignore_skip_hint; /* Scan blocks even if marked skip */
9f7e3387 190 bool ignore_block_suitable; /* Scan blocks considered unsuitable */
accf6242 191 bool direct_compaction; /* False from kcompactd or /proc/... */
06ed2998 192 bool whole_zone; /* Whole zone should/has been scanned */
ff9543fd 193 int order; /* order a direct compactor needs */
6d7ce559 194 const gfp_t gfp_mask; /* gfp mask of a direct compactor */
c603844b 195 const unsigned int alloc_flags; /* alloc flags of a direct compactor */
ebff3980 196 const int classzone_idx; /* zone index of a direct compactor */
ff9543fd 197 struct zone *zone;
c3486f53 198 bool contended; /* Signal lock or sched contention */
ff9543fd
MN
199};
200
201unsigned long
bb13ffeb
MG
202isolate_freepages_range(struct compact_control *cc,
203 unsigned long start_pfn, unsigned long end_pfn);
ff9543fd 204unsigned long
edc2ca61
VB
205isolate_migratepages_range(struct compact_control *cc,
206 unsigned long low_pfn, unsigned long end_pfn);
2149cdae
JK
207int find_suitable_fallback(struct free_area *area, unsigned int order,
208 int migratetype, bool only_stealable, bool *can_steal);
ff9543fd
MN
209
210#endif
0f8053a5 211
48f13bf3 212/*
6c14466c
MG
213 * This function returns the order of a free page in the buddy system. In
214 * general, page_zone(page)->lock must be held by the caller to prevent the
215 * page from being allocated in parallel and returning garbage as the order.
216 * If a caller does not hold page_zone(page)->lock, it must guarantee that the
99c0fd5e
VB
217 * page cannot be allocated or merged in parallel. Alternatively, it must
218 * handle invalid values gracefully, and use page_order_unsafe() below.
48f13bf3 219 */
d00181b9 220static inline unsigned int page_order(struct page *page)
48f13bf3 221{
572438f9 222 /* PageBuddy() must be checked by the caller */
48f13bf3
MG
223 return page_private(page);
224}
b5a0e011 225
99c0fd5e
VB
226/*
227 * Like page_order(), but for callers who cannot afford to hold the zone lock.
228 * PageBuddy() should be checked first by the caller to minimize race window,
229 * and invalid values must be handled gracefully.
230 *
4db0c3c2 231 * READ_ONCE is used so that if the caller assigns the result into a local
99c0fd5e
VB
232 * variable and e.g. tests it for valid range before using, the compiler cannot
233 * decide to remove the variable and inline the page_private(page) multiple
234 * times, potentially observing different values in the tests and the actual
235 * use of the result.
236 */
4db0c3c2 237#define page_order_unsafe(page) READ_ONCE(page_private(page))
99c0fd5e 238
4bbd4c77
KS
239static inline bool is_cow_mapping(vm_flags_t flags)
240{
241 return (flags & (VM_SHARED | VM_MAYWRITE)) == VM_MAYWRITE;
242}
243
30bdbb78
KK
244/*
245 * These three helpers classifies VMAs for virtual memory accounting.
246 */
247
248/*
249 * Executable code area - executable, not writable, not stack
250 */
d977d56c
KK
251static inline bool is_exec_mapping(vm_flags_t flags)
252{
30bdbb78 253 return (flags & (VM_EXEC | VM_WRITE | VM_STACK)) == VM_EXEC;
d977d56c
KK
254}
255
30bdbb78
KK
256/*
257 * Stack area - atomatically grows in one direction
258 *
259 * VM_GROWSUP / VM_GROWSDOWN VMAs are always private anonymous:
260 * do_mmap() forbids all other combinations.
261 */
d977d56c
KK
262static inline bool is_stack_mapping(vm_flags_t flags)
263{
30bdbb78 264 return (flags & VM_STACK) == VM_STACK;
d977d56c
KK
265}
266
30bdbb78
KK
267/*
268 * Data area - private, writable, not stack
269 */
d977d56c
KK
270static inline bool is_data_mapping(vm_flags_t flags)
271{
30bdbb78 272 return (flags & (VM_WRITE | VM_SHARED | VM_STACK)) == VM_WRITE;
d977d56c
KK
273}
274
6038def0
NK
275/* mm/util.c */
276void __vma_link_list(struct mm_struct *mm, struct vm_area_struct *vma,
277 struct vm_area_struct *prev, struct rb_node *rb_parent);
278
af8e3354 279#ifdef CONFIG_MMU
fc05f566 280extern long populate_vma_page_range(struct vm_area_struct *vma,
cea10a19 281 unsigned long start, unsigned long end, int *nonblocking);
af8e3354
HD
282extern void munlock_vma_pages_range(struct vm_area_struct *vma,
283 unsigned long start, unsigned long end);
284static inline void munlock_vma_pages_all(struct vm_area_struct *vma)
285{
286 munlock_vma_pages_range(vma, vma->vm_start, vma->vm_end);
287}
288
b291f000 289/*
73848b46 290 * must be called with vma's mmap_sem held for read or write, and page locked.
b291f000
NP
291 */
292extern void mlock_vma_page(struct page *page);
ff6a6da6 293extern unsigned int munlock_vma_page(struct page *page);
b291f000
NP
294
295/*
296 * Clear the page's PageMlocked(). This can be useful in a situation where
297 * we want to unconditionally remove a page from the pagecache -- e.g.,
298 * on truncation or freeing.
299 *
300 * It is legal to call this function for any page, mlocked or not.
301 * If called for a page that is still mapped by mlocked vmas, all we do
302 * is revert to lazy LRU behaviour -- semantics are not broken.
303 */
e6c509f8 304extern void clear_page_mlock(struct page *page);
b291f000
NP
305
306/*
51afb12b
HD
307 * mlock_migrate_page - called only from migrate_misplaced_transhuge_page()
308 * (because that does not go through the full procedure of migration ptes):
309 * to migrate the Mlocked page flag; update statistics.
b291f000
NP
310 */
311static inline void mlock_migrate_page(struct page *newpage, struct page *page)
312{
5344b7e6 313 if (TestClearPageMlocked(page)) {
b32967ff 314 int nr_pages = hpage_nr_pages(page);
5344b7e6 315
51afb12b 316 /* Holding pmd lock, no change in irq context: __mod is safe */
b32967ff 317 __mod_zone_page_state(page_zone(page), NR_MLOCK, -nr_pages);
b291f000 318 SetPageMlocked(newpage);
b32967ff 319 __mod_zone_page_state(page_zone(newpage), NR_MLOCK, nr_pages);
5344b7e6 320 }
b291f000
NP
321}
322
b32967ff
MG
323extern pmd_t maybe_pmd_mkwrite(pmd_t pmd, struct vm_area_struct *vma);
324
e9b61f19
KS
325/*
326 * At what user virtual address is page expected in @vma?
327 */
328static inline unsigned long
329__vma_address(struct page *page, struct vm_area_struct *vma)
330{
331 pgoff_t pgoff = page_to_pgoff(page);
332 return vma->vm_start + ((pgoff - vma->vm_pgoff) << PAGE_SHIFT);
333}
334
335static inline unsigned long
336vma_address(struct page *page, struct vm_area_struct *vma)
337{
a8fa41ad
KS
338 unsigned long start, end;
339
340 start = __vma_address(page, vma);
341 end = start + PAGE_SIZE * (hpage_nr_pages(page) - 1);
e9b61f19
KS
342
343 /* page should be within @vma mapping range */
a8fa41ad 344 VM_BUG_ON_VMA(end < vma->vm_start || start >= vma->vm_end, vma);
e9b61f19 345
a8fa41ad 346 return max(start, vma->vm_start);
e9b61f19
KS
347}
348
af8e3354 349#else /* !CONFIG_MMU */
b291f000
NP
350static inline void clear_page_mlock(struct page *page) { }
351static inline void mlock_vma_page(struct page *page) { }
352static inline void mlock_migrate_page(struct page *new, struct page *old) { }
353
af8e3354 354#endif /* !CONFIG_MMU */
894bc310 355
69d177c2
AW
356/*
357 * Return the mem_map entry representing the 'offset' subpage within
358 * the maximally aligned gigantic page 'base'. Handle any discontiguity
359 * in the mem_map at MAX_ORDER_NR_PAGES boundaries.
360 */
361static inline struct page *mem_map_offset(struct page *base, int offset)
362{
363 if (unlikely(offset >= MAX_ORDER_NR_PAGES))
bc7f84c0 364 return nth_page(base, offset);
69d177c2
AW
365 return base + offset;
366}
367
368/*
25985edc 369 * Iterator over all subpages within the maximally aligned gigantic
69d177c2
AW
370 * page 'base'. Handle any discontiguity in the mem_map.
371 */
372static inline struct page *mem_map_next(struct page *iter,
373 struct page *base, int offset)
374{
375 if (unlikely((offset & (MAX_ORDER_NR_PAGES - 1)) == 0)) {
376 unsigned long pfn = page_to_pfn(base) + offset;
377 if (!pfn_valid(pfn))
378 return NULL;
379 return pfn_to_page(pfn);
380 }
381 return iter + 1;
382}
383
b5a0e011
AH
384/*
385 * FLATMEM and DISCONTIGMEM configurations use alloc_bootmem_node,
386 * so all functions starting at paging_init should be marked __init
387 * in those cases. SPARSEMEM, however, allows for memory hotplug,
388 * and alloc_bootmem_node is not used.
389 */
390#ifdef CONFIG_SPARSEMEM
391#define __paginginit __meminit
392#else
393#define __paginginit __init
394#endif
395
6b74ab97
MG
396/* Memory initialisation debug and verification */
397enum mminit_level {
398 MMINIT_WARNING,
399 MMINIT_VERIFY,
400 MMINIT_TRACE
401};
402
403#ifdef CONFIG_DEBUG_MEMORY_INIT
404
405extern int mminit_loglevel;
406
407#define mminit_dprintk(level, prefix, fmt, arg...) \
408do { \
409 if (level < mminit_loglevel) { \
fc5199d1 410 if (level <= MMINIT_WARNING) \
1170532b 411 pr_warn("mminit::" prefix " " fmt, ##arg); \
fc5199d1
RV
412 else \
413 printk(KERN_DEBUG "mminit::" prefix " " fmt, ##arg); \
6b74ab97
MG
414 } \
415} while (0)
416
708614e6 417extern void mminit_verify_pageflags_layout(void);
68ad8df4 418extern void mminit_verify_zonelist(void);
6b74ab97
MG
419#else
420
421static inline void mminit_dprintk(enum mminit_level level,
422 const char *prefix, const char *fmt, ...)
423{
424}
425
708614e6
MG
426static inline void mminit_verify_pageflags_layout(void)
427{
428}
429
68ad8df4
MG
430static inline void mminit_verify_zonelist(void)
431{
432}
6b74ab97 433#endif /* CONFIG_DEBUG_MEMORY_INIT */
2dbb51c4
MG
434
435/* mminit_validate_memmodel_limits is independent of CONFIG_DEBUG_MEMORY_INIT */
436#if defined(CONFIG_SPARSEMEM)
437extern void mminit_validate_memmodel_limits(unsigned long *start_pfn,
438 unsigned long *end_pfn);
439#else
440static inline void mminit_validate_memmodel_limits(unsigned long *start_pfn,
441 unsigned long *end_pfn)
442{
443}
444#endif /* CONFIG_SPARSEMEM */
445
a5f5f91d
MG
446#define NODE_RECLAIM_NOSCAN -2
447#define NODE_RECLAIM_FULL -1
448#define NODE_RECLAIM_SOME 0
449#define NODE_RECLAIM_SUCCESS 1
7c116f2b 450
31d3d348
WF
451extern int hwpoison_filter(struct page *p);
452
7c116f2b
WF
453extern u32 hwpoison_filter_dev_major;
454extern u32 hwpoison_filter_dev_minor;
478c5ffc
WF
455extern u64 hwpoison_filter_flags_mask;
456extern u64 hwpoison_filter_flags_value;
4fd466eb 457extern u64 hwpoison_filter_memcg;
1bfe5feb 458extern u32 hwpoison_filter_enable;
eb36c587 459
dc0ef0df 460extern unsigned long __must_check vm_mmap_pgoff(struct file *, unsigned long,
eb36c587 461 unsigned long, unsigned long,
9fbeb5ab 462 unsigned long, unsigned long);
ca57df79
XQ
463
464extern void set_pageblock_order(void);
02c6de8d
MK
465unsigned long reclaim_clean_pages_from_list(struct zone *zone,
466 struct list_head *page_list);
d95ea5d1
BZ
467/* The ALLOC_WMARK bits are used as an index to zone->watermark */
468#define ALLOC_WMARK_MIN WMARK_MIN
469#define ALLOC_WMARK_LOW WMARK_LOW
470#define ALLOC_WMARK_HIGH WMARK_HIGH
471#define ALLOC_NO_WATERMARKS 0x04 /* don't check watermarks at all */
472
473/* Mask to get the watermark bits */
474#define ALLOC_WMARK_MASK (ALLOC_NO_WATERMARKS-1)
475
476#define ALLOC_HARDER 0x10 /* try to alloc harder */
477#define ALLOC_HIGH 0x20 /* __GFP_HIGH set */
478#define ALLOC_CPUSET 0x40 /* check for correct cpuset */
479#define ALLOC_CMA 0x80 /* allow allocations from CMA areas */
480
72b252ae
MG
481enum ttu_flags;
482struct tlbflush_unmap_batch;
483
484#ifdef CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH
485void try_to_unmap_flush(void);
d950c947 486void try_to_unmap_flush_dirty(void);
72b252ae
MG
487#else
488static inline void try_to_unmap_flush(void)
489{
490}
d950c947
MG
491static inline void try_to_unmap_flush_dirty(void)
492{
493}
72b252ae
MG
494
495#endif /* CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH */
edf14cdb
VB
496
497extern const struct trace_print_flags pageflag_names[];
498extern const struct trace_print_flags vmaflag_names[];
499extern const struct trace_print_flags gfpflag_names[];
500
db971418 501#endif /* __MM_INTERNAL_H */