]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - include/linux/memcontrol.h
6054c9f3a5e81d75f300fa60777bae8a933577a1
[karo-tx-linux.git] / include / linux / memcontrol.h
1 /* memcontrol.h - Memory Controller
2  *
3  * Copyright IBM Corporation, 2007
4  * Author Balbir Singh <balbir@linux.vnet.ibm.com>
5  *
6  * Copyright 2007 OpenVZ SWsoft Inc
7  * Author: Pavel Emelianov <xemul@openvz.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  */
19
20 #ifndef _LINUX_MEMCONTROL_H
21 #define _LINUX_MEMCONTROL_H
22 #include <linux/cgroup.h>
23 #include <linux/vm_event_item.h>
24 #include <linux/hardirq.h>
25 #include <linux/jump_label.h>
26
27 struct mem_cgroup;
28 struct page_cgroup;
29 struct page;
30 struct mm_struct;
31 struct kmem_cache;
32
33 /*
34  * The corresponding mem_cgroup_stat_names is defined in mm/memcontrol.c,
35  * These two lists should keep in accord with each other.
36  */
37 enum mem_cgroup_stat_index {
38         /*
39          * For MEM_CONTAINER_TYPE_ALL, usage = pagecache + rss.
40          */
41         MEM_CGROUP_STAT_CACHE,          /* # of pages charged as cache */
42         MEM_CGROUP_STAT_RSS,            /* # of pages charged as anon rss */
43         MEM_CGROUP_STAT_RSS_HUGE,       /* # of pages charged as anon huge */
44         MEM_CGROUP_STAT_FILE_MAPPED,    /* # of pages charged as file rss */
45         MEM_CGROUP_STAT_WRITEBACK,      /* # of pages under writeback */
46         MEM_CGROUP_STAT_SWAP,           /* # of pages, swapped out */
47         MEM_CGROUP_STAT_NSTATS,
48 };
49
50 struct mem_cgroup_reclaim_cookie {
51         struct zone *zone;
52         int priority;
53         unsigned int generation;
54 };
55
56 #ifdef CONFIG_MEMCG
57 /*
58  * All "charge" functions with gfp_mask should use GFP_KERNEL or
59  * (gfp_mask & GFP_RECLAIM_MASK). In current implementatin, memcg doesn't
60  * alloc memory but reclaims memory from all available zones. So, "where I want
61  * memory from" bits of gfp_mask has no meaning. So any bits of that field is
62  * available but adding a rule is better. charge functions' gfp_mask should
63  * be set to GFP_KERNEL or gfp_mask & GFP_RECLAIM_MASK for avoiding ambiguous
64  * codes.
65  * (Of course, if memcg does memory allocation in future, GFP_KERNEL is sane.)
66  */
67
68 extern int mem_cgroup_newpage_charge(struct page *page, struct mm_struct *mm,
69                                 gfp_t gfp_mask);
70 /* for swap handling */
71 extern int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
72                 struct page *page, gfp_t mask, struct mem_cgroup **memcgp);
73 extern void mem_cgroup_commit_charge_swapin(struct page *page,
74                                         struct mem_cgroup *memcg);
75 extern void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg);
76
77 extern int mem_cgroup_cache_charge(struct page *page, struct mm_struct *mm,
78                                         gfp_t gfp_mask);
79
80 struct lruvec *mem_cgroup_zone_lruvec(struct zone *, struct mem_cgroup *);
81 struct lruvec *mem_cgroup_page_lruvec(struct page *, struct zone *);
82
83 /* For coalescing uncharge for reducing memcg' overhead*/
84 extern void mem_cgroup_uncharge_start(void);
85 extern void mem_cgroup_uncharge_end(void);
86
87 extern void mem_cgroup_uncharge_page(struct page *page);
88 extern void mem_cgroup_uncharge_cache_page(struct page *page);
89
90 bool __mem_cgroup_same_or_subtree(const struct mem_cgroup *root_memcg,
91                                   struct mem_cgroup *memcg);
92 bool task_in_mem_cgroup(struct task_struct *task,
93                         const struct mem_cgroup *memcg);
94
95 extern struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page);
96 extern struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
97 extern struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm);
98
99 extern struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg);
100 extern struct mem_cgroup *mem_cgroup_from_css(struct cgroup_subsys_state *css);
101
102 static inline
103 bool mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *memcg)
104 {
105         struct mem_cgroup *task_memcg;
106         bool match;
107
108         rcu_read_lock();
109         task_memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
110         match = __mem_cgroup_same_or_subtree(memcg, task_memcg);
111         rcu_read_unlock();
112         return match;
113 }
114
115 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
116
117 extern void
118 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
119                              struct mem_cgroup **memcgp);
120 extern void mem_cgroup_end_migration(struct mem_cgroup *memcg,
121         struct page *oldpage, struct page *newpage, bool migration_ok);
122
123 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
124                                    struct mem_cgroup *,
125                                    struct mem_cgroup_reclaim_cookie *);
126 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
127
128 /*
129  * For memory reclaim.
130  */
131 int mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec);
132 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
133 unsigned long mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list);
134 void mem_cgroup_update_lru_size(struct lruvec *, enum lru_list, int);
135 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
136                                         struct task_struct *p);
137 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
138                                         struct page *newpage);
139
140 /**
141  * mem_cgroup_toggle_oom - toggle the memcg OOM killer for the current task
142  * @new: true to enable, false to disable
143  *
144  * Toggle whether a failed memcg charge should invoke the OOM killer
145  * or just return -ENOMEM.  Returns the previous toggle state.
146  *
147  * NOTE: Any path that enables the OOM killer before charging must
148  *       call mem_cgroup_oom_synchronize() afterward to finalize the
149  *       OOM handling and clean up.
150  */
151 static inline bool mem_cgroup_toggle_oom(bool new)
152 {
153         bool old;
154
155         old = current->memcg_oom.may_oom;
156         current->memcg_oom.may_oom = new;
157
158         return old;
159 }
160
161 static inline void mem_cgroup_enable_oom(void)
162 {
163         bool old = mem_cgroup_toggle_oom(true);
164
165         WARN_ON(old == true);
166 }
167
168 static inline void mem_cgroup_disable_oom(void)
169 {
170         bool old = mem_cgroup_toggle_oom(false);
171
172         WARN_ON(old == false);
173 }
174
175 static inline bool task_in_memcg_oom(struct task_struct *p)
176 {
177         return p->memcg_oom.in_memcg_oom;
178 }
179
180 bool mem_cgroup_oom_synchronize(void);
181
182 #ifdef CONFIG_MEMCG_SWAP
183 extern int do_swap_account;
184 #endif
185
186 static inline bool mem_cgroup_disabled(void)
187 {
188         if (mem_cgroup_subsys.disabled)
189                 return true;
190         return false;
191 }
192
193 void __mem_cgroup_begin_update_page_stat(struct page *page, bool *locked,
194                                          unsigned long *flags);
195
196 extern atomic_t memcg_moving;
197
198 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
199                                         bool *locked, unsigned long *flags)
200 {
201         if (mem_cgroup_disabled())
202                 return;
203         rcu_read_lock();
204         *locked = false;
205         if (atomic_read(&memcg_moving))
206                 __mem_cgroup_begin_update_page_stat(page, locked, flags);
207 }
208
209 void __mem_cgroup_end_update_page_stat(struct page *page,
210                                 unsigned long *flags);
211 static inline void mem_cgroup_end_update_page_stat(struct page *page,
212                                         bool *locked, unsigned long *flags)
213 {
214         if (mem_cgroup_disabled())
215                 return;
216         if (*locked)
217                 __mem_cgroup_end_update_page_stat(page, flags);
218         rcu_read_unlock();
219 }
220
221 void mem_cgroup_update_page_stat(struct page *page,
222                                  enum mem_cgroup_stat_index idx,
223                                  int val);
224
225 static inline void mem_cgroup_inc_page_stat(struct page *page,
226                                             enum mem_cgroup_stat_index idx)
227 {
228         mem_cgroup_update_page_stat(page, idx, 1);
229 }
230
231 static inline void mem_cgroup_dec_page_stat(struct page *page,
232                                             enum mem_cgroup_stat_index idx)
233 {
234         mem_cgroup_update_page_stat(page, idx, -1);
235 }
236
237 bool mem_cgroup_soft_reclaim_eligible(struct mem_cgroup *memcg);
238
239 void __mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
240 static inline void mem_cgroup_count_vm_event(struct mm_struct *mm,
241                                              enum vm_event_item idx)
242 {
243         if (mem_cgroup_disabled())
244                 return;
245         __mem_cgroup_count_vm_event(mm, idx);
246 }
247 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
248 void mem_cgroup_split_huge_fixup(struct page *head);
249 #endif
250
251 #ifdef CONFIG_DEBUG_VM
252 bool mem_cgroup_bad_page_check(struct page *page);
253 void mem_cgroup_print_bad_page(struct page *page);
254 #endif
255 #else /* CONFIG_MEMCG */
256 struct mem_cgroup;
257
258 static inline int mem_cgroup_newpage_charge(struct page *page,
259                                         struct mm_struct *mm, gfp_t gfp_mask)
260 {
261         return 0;
262 }
263
264 static inline int mem_cgroup_cache_charge(struct page *page,
265                                         struct mm_struct *mm, gfp_t gfp_mask)
266 {
267         return 0;
268 }
269
270 static inline int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
271                 struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
272 {
273         return 0;
274 }
275
276 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
277                                           struct mem_cgroup *memcg)
278 {
279 }
280
281 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
282 {
283 }
284
285 static inline void mem_cgroup_uncharge_start(void)
286 {
287 }
288
289 static inline void mem_cgroup_uncharge_end(void)
290 {
291 }
292
293 static inline void mem_cgroup_uncharge_page(struct page *page)
294 {
295 }
296
297 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
298 {
299 }
300
301 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
302                                                     struct mem_cgroup *memcg)
303 {
304         return &zone->lruvec;
305 }
306
307 static inline struct lruvec *mem_cgroup_page_lruvec(struct page *page,
308                                                     struct zone *zone)
309 {
310         return &zone->lruvec;
311 }
312
313 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
314 {
315         return NULL;
316 }
317
318 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
319 {
320         return NULL;
321 }
322
323 static inline bool mm_match_cgroup(struct mm_struct *mm,
324                 struct mem_cgroup *memcg)
325 {
326         return true;
327 }
328
329 static inline bool task_in_mem_cgroup(struct task_struct *task,
330                                       const struct mem_cgroup *memcg)
331 {
332         return true;
333 }
334
335 static inline struct cgroup_subsys_state
336                 *mem_cgroup_css(struct mem_cgroup *memcg)
337 {
338         return NULL;
339 }
340
341 static inline void
342 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
343                              struct mem_cgroup **memcgp)
344 {
345 }
346
347 static inline void mem_cgroup_end_migration(struct mem_cgroup *memcg,
348                 struct page *oldpage, struct page *newpage, bool migration_ok)
349 {
350 }
351
352 static inline struct mem_cgroup *
353 mem_cgroup_iter(struct mem_cgroup *root,
354                 struct mem_cgroup *prev,
355                 struct mem_cgroup_reclaim_cookie *reclaim)
356 {
357         return NULL;
358 }
359
360 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
361                                          struct mem_cgroup *prev)
362 {
363 }
364
365 static inline bool mem_cgroup_disabled(void)
366 {
367         return true;
368 }
369
370 static inline int
371 mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec)
372 {
373         return 1;
374 }
375
376 static inline unsigned long
377 mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list lru)
378 {
379         return 0;
380 }
381
382 static inline void
383 mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
384                               int increment)
385 {
386 }
387
388 static inline void
389 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
390 {
391 }
392
393 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
394                                         bool *locked, unsigned long *flags)
395 {
396 }
397
398 static inline void mem_cgroup_end_update_page_stat(struct page *page,
399                                         bool *locked, unsigned long *flags)
400 {
401 }
402
403 static inline bool mem_cgroup_toggle_oom(bool new)
404 {
405         return false;
406 }
407
408 static inline void mem_cgroup_enable_oom(void)
409 {
410 }
411
412 static inline void mem_cgroup_disable_oom(void)
413 {
414 }
415
416 static inline bool task_in_memcg_oom(struct task_struct *p)
417 {
418         return false;
419 }
420
421 static inline bool mem_cgroup_oom_synchronize(void)
422 {
423         return false;
424 }
425
426 static inline void mem_cgroup_inc_page_stat(struct page *page,
427                                             enum mem_cgroup_stat_index idx)
428 {
429 }
430
431 static inline void mem_cgroup_dec_page_stat(struct page *page,
432                                             enum mem_cgroup_stat_index idx)
433 {
434 }
435
436 static inline
437 bool mem_cgroup_soft_reclaim_eligible(struct mem_cgroup *memcg)
438 {
439         return false;
440 }
441
442 static inline void mem_cgroup_split_huge_fixup(struct page *head)
443 {
444 }
445
446 static inline
447 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
448 {
449 }
450 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
451                                 struct page *newpage)
452 {
453 }
454 #endif /* CONFIG_MEMCG */
455
456 #if !defined(CONFIG_MEMCG) || !defined(CONFIG_DEBUG_VM)
457 static inline bool
458 mem_cgroup_bad_page_check(struct page *page)
459 {
460         return false;
461 }
462
463 static inline void
464 mem_cgroup_print_bad_page(struct page *page)
465 {
466 }
467 #endif
468
469 enum {
470         UNDER_LIMIT,
471         SOFT_LIMIT,
472         OVER_LIMIT,
473 };
474
475 struct sock;
476 #if defined(CONFIG_INET) && defined(CONFIG_MEMCG_KMEM)
477 void sock_update_memcg(struct sock *sk);
478 void sock_release_memcg(struct sock *sk);
479 #else
480 static inline void sock_update_memcg(struct sock *sk)
481 {
482 }
483 static inline void sock_release_memcg(struct sock *sk)
484 {
485 }
486 #endif /* CONFIG_INET && CONFIG_MEMCG_KMEM */
487
488 #ifdef CONFIG_MEMCG_KMEM
489 extern struct static_key memcg_kmem_enabled_key;
490
491 extern int memcg_limited_groups_array_size;
492
493 /*
494  * Helper macro to loop through all memcg-specific caches. Callers must still
495  * check if the cache is valid (it is either valid or NULL).
496  * the slab_mutex must be held when looping through those caches
497  */
498 #define for_each_memcg_cache_index(_idx)        \
499         for ((_idx) = 0; (_idx) < memcg_limited_groups_array_size; (_idx)++)
500
501 static inline bool memcg_kmem_enabled(void)
502 {
503         return static_key_false(&memcg_kmem_enabled_key);
504 }
505
506 /*
507  * In general, we'll do everything in our power to not incur in any overhead
508  * for non-memcg users for the kmem functions. Not even a function call, if we
509  * can avoid it.
510  *
511  * Therefore, we'll inline all those functions so that in the best case, we'll
512  * see that kmemcg is off for everybody and proceed quickly.  If it is on,
513  * we'll still do most of the flag checking inline. We check a lot of
514  * conditions, but because they are pretty simple, they are expected to be
515  * fast.
516  */
517 bool __memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg,
518                                         int order);
519 void __memcg_kmem_commit_charge(struct page *page,
520                                        struct mem_cgroup *memcg, int order);
521 void __memcg_kmem_uncharge_pages(struct page *page, int order);
522
523 int memcg_cache_id(struct mem_cgroup *memcg);
524 int memcg_register_cache(struct mem_cgroup *memcg, struct kmem_cache *s,
525                          struct kmem_cache *root_cache);
526 void memcg_release_cache(struct kmem_cache *cachep);
527 void memcg_cache_list_add(struct mem_cgroup *memcg, struct kmem_cache *cachep);
528
529 int memcg_update_cache_size(struct kmem_cache *s, int num_groups);
530 void memcg_update_array_size(int num_groups);
531
532 struct kmem_cache *
533 __memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp);
534
535 void mem_cgroup_destroy_cache(struct kmem_cache *cachep);
536 void kmem_cache_destroy_memcg_children(struct kmem_cache *s);
537
538 /**
539  * memcg_kmem_newpage_charge: verify if a new kmem allocation is allowed.
540  * @gfp: the gfp allocation flags.
541  * @memcg: a pointer to the memcg this was charged against.
542  * @order: allocation order.
543  *
544  * returns true if the memcg where the current task belongs can hold this
545  * allocation.
546  *
547  * We return true automatically if this allocation is not to be accounted to
548  * any memcg.
549  */
550 static inline bool
551 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
552 {
553         if (!memcg_kmem_enabled())
554                 return true;
555
556         /*
557          * __GFP_NOFAIL allocations will move on even if charging is not
558          * possible. Therefore we don't even try, and have this allocation
559          * unaccounted. We could in theory charge it with
560          * res_counter_charge_nofail, but we hope those allocations are rare,
561          * and won't be worth the trouble.
562          */
563         if (!(gfp & __GFP_KMEMCG) || (gfp & __GFP_NOFAIL))
564                 return true;
565         if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
566                 return true;
567
568         /* If the test is dying, just let it go. */
569         if (unlikely(fatal_signal_pending(current)))
570                 return true;
571
572         return __memcg_kmem_newpage_charge(gfp, memcg, order);
573 }
574
575 /**
576  * memcg_kmem_uncharge_pages: uncharge pages from memcg
577  * @page: pointer to struct page being freed
578  * @order: allocation order.
579  *
580  * there is no need to specify memcg here, since it is embedded in page_cgroup
581  */
582 static inline void
583 memcg_kmem_uncharge_pages(struct page *page, int order)
584 {
585         if (memcg_kmem_enabled())
586                 __memcg_kmem_uncharge_pages(page, order);
587 }
588
589 /**
590  * memcg_kmem_commit_charge: embeds correct memcg in a page
591  * @page: pointer to struct page recently allocated
592  * @memcg: the memcg structure we charged against
593  * @order: allocation order.
594  *
595  * Needs to be called after memcg_kmem_newpage_charge, regardless of success or
596  * failure of the allocation. if @page is NULL, this function will revert the
597  * charges. Otherwise, it will commit the memcg given by @memcg to the
598  * corresponding page_cgroup.
599  */
600 static inline void
601 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
602 {
603         if (memcg_kmem_enabled() && memcg)
604                 __memcg_kmem_commit_charge(page, memcg, order);
605 }
606
607 /**
608  * memcg_kmem_get_cache: selects the correct per-memcg cache for allocation
609  * @cachep: the original global kmem cache
610  * @gfp: allocation flags.
611  *
612  * This function assumes that the task allocating, which determines the memcg
613  * in the page allocator, belongs to the same cgroup throughout the whole
614  * process.  Misacounting can happen if the task calls memcg_kmem_get_cache()
615  * while belonging to a cgroup, and later on changes. This is considered
616  * acceptable, and should only happen upon task migration.
617  *
618  * Before the cache is created by the memcg core, there is also a possible
619  * imbalance: the task belongs to a memcg, but the cache being allocated from
620  * is the global cache, since the child cache is not yet guaranteed to be
621  * ready. This case is also fine, since in this case the GFP_KMEMCG will not be
622  * passed and the page allocator will not attempt any cgroup accounting.
623  */
624 static __always_inline struct kmem_cache *
625 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
626 {
627         if (!memcg_kmem_enabled())
628                 return cachep;
629         if (gfp & __GFP_NOFAIL)
630                 return cachep;
631         if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
632                 return cachep;
633         if (unlikely(fatal_signal_pending(current)))
634                 return cachep;
635
636         return __memcg_kmem_get_cache(cachep, gfp);
637 }
638 #else
639 #define for_each_memcg_cache_index(_idx)        \
640         for (; NULL; )
641
642 static inline bool memcg_kmem_enabled(void)
643 {
644         return false;
645 }
646
647 static inline bool
648 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
649 {
650         return true;
651 }
652
653 static inline void memcg_kmem_uncharge_pages(struct page *page, int order)
654 {
655 }
656
657 static inline void
658 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
659 {
660 }
661
662 static inline int memcg_cache_id(struct mem_cgroup *memcg)
663 {
664         return -1;
665 }
666
667 static inline int
668 memcg_register_cache(struct mem_cgroup *memcg, struct kmem_cache *s,
669                      struct kmem_cache *root_cache)
670 {
671         return 0;
672 }
673
674 static inline void memcg_release_cache(struct kmem_cache *cachep)
675 {
676 }
677
678 static inline void memcg_cache_list_add(struct mem_cgroup *memcg,
679                                         struct kmem_cache *s)
680 {
681 }
682
683 static inline struct kmem_cache *
684 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
685 {
686         return cachep;
687 }
688
689 static inline void kmem_cache_destroy_memcg_children(struct kmem_cache *s)
690 {
691 }
692 #endif /* CONFIG_MEMCG_KMEM */
693 #endif /* _LINUX_MEMCONTROL_H */
694