1 /* memcontrol.h - Memory Controller
3 * Copyright IBM Corporation, 2007
4 * Author Balbir Singh <balbir@linux.vnet.ibm.com>
6 * Copyright 2007 OpenVZ SWsoft Inc
7 * Author: Pavel Emelianov <xemul@openvz.org>
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.
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.
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 #include <linux/page_counter.h>
27 #include <linux/vmpressure.h>
28 #include <linux/eventfd.h>
29 #include <linux/mmzone.h>
30 #include <linux/writeback.h>
38 * The corresponding mem_cgroup_stat_names is defined in mm/memcontrol.c,
39 * These two lists should keep in accord with each other.
41 enum mem_cgroup_stat_index {
43 * For MEM_CONTAINER_TYPE_ALL, usage = pagecache + rss.
45 MEM_CGROUP_STAT_CACHE, /* # of pages charged as cache */
46 MEM_CGROUP_STAT_RSS, /* # of pages charged as anon rss */
47 MEM_CGROUP_STAT_RSS_HUGE, /* # of pages charged as anon huge */
48 MEM_CGROUP_STAT_FILE_MAPPED, /* # of pages charged as file rss */
49 MEM_CGROUP_STAT_DIRTY, /* # of dirty pages in page cache */
50 MEM_CGROUP_STAT_WRITEBACK, /* # of pages under writeback */
51 MEM_CGROUP_STAT_SWAP, /* # of pages, swapped out */
52 MEM_CGROUP_STAT_NSTATS,
55 struct mem_cgroup_reclaim_cookie {
58 unsigned int generation;
61 enum mem_cgroup_events_index {
62 MEM_CGROUP_EVENTS_PGPGIN, /* # of pages paged in */
63 MEM_CGROUP_EVENTS_PGPGOUT, /* # of pages paged out */
64 MEM_CGROUP_EVENTS_PGFAULT, /* # of page-faults */
65 MEM_CGROUP_EVENTS_PGMAJFAULT, /* # of major page-faults */
66 MEM_CGROUP_EVENTS_NSTATS,
67 /* default hierarchy events */
68 MEMCG_LOW = MEM_CGROUP_EVENTS_NSTATS,
76 * Per memcg event counter is incremented at every pagein/pageout. With THP,
77 * it will be incremated by the number of pages. This counter is used for
78 * for trigger some periodic events. This is straightforward and better
79 * than using jiffies etc. to handle periodic memcg event.
81 enum mem_cgroup_events_target {
82 MEM_CGROUP_TARGET_THRESH,
83 MEM_CGROUP_TARGET_SOFTLIMIT,
84 MEM_CGROUP_TARGET_NUMAINFO,
89 struct page_counter memory_allocated; /* Current allocated memory. */
95 struct mem_cgroup_stat_cpu {
96 long count[MEM_CGROUP_STAT_NSTATS];
97 unsigned long events[MEMCG_NR_EVENTS];
98 unsigned long nr_page_events;
99 unsigned long targets[MEM_CGROUP_NTARGETS];
102 struct mem_cgroup_reclaim_iter {
103 struct mem_cgroup *position;
104 /* scan generation, increased every round-trip */
105 unsigned int generation;
109 * per-zone information in memory controller.
111 struct mem_cgroup_per_zone {
112 struct lruvec lruvec;
113 unsigned long lru_size[NR_LRU_LISTS];
115 struct mem_cgroup_reclaim_iter iter[DEF_PRIORITY + 1];
117 struct rb_node tree_node; /* RB tree node */
118 unsigned long usage_in_excess;/* Set to the value by which */
119 /* the soft limit is exceeded*/
121 struct mem_cgroup *memcg; /* Back pointer, we cannot */
122 /* use container_of */
125 struct mem_cgroup_per_node {
126 struct mem_cgroup_per_zone zoneinfo[MAX_NR_ZONES];
129 struct mem_cgroup_threshold {
130 struct eventfd_ctx *eventfd;
131 unsigned long threshold;
135 struct mem_cgroup_threshold_ary {
136 /* An array index points to threshold just below or equal to usage. */
137 int current_threshold;
138 /* Size of entries[] */
140 /* Array of thresholds */
141 struct mem_cgroup_threshold entries[0];
144 struct mem_cgroup_thresholds {
145 /* Primary thresholds array */
146 struct mem_cgroup_threshold_ary *primary;
148 * Spare threshold array.
149 * This is needed to make mem_cgroup_unregister_event() "never fail".
150 * It must be able to store at least primary->size - 1 entries.
152 struct mem_cgroup_threshold_ary *spare;
156 * The memory controller data structure. The memory controller controls both
157 * page cache and RSS per cgroup. We would eventually like to provide
158 * statistics based on the statistics developed by Rik Van Riel for clock-pro,
159 * to help the administrator determine what knobs to tune.
162 struct cgroup_subsys_state css;
164 /* Accounted resources */
165 struct page_counter memory;
166 struct page_counter memsw;
167 struct page_counter kmem;
169 /* Normal memory consumption range */
173 /* Range enforcement for interrupt charges */
174 struct work_struct high_work;
176 unsigned long soft_limit;
178 /* vmpressure notifications */
179 struct vmpressure vmpressure;
181 /* css_online() has been completed */
185 * Should the accounting and control be hierarchical, per subtree?
189 /* protected by memcg_oom_lock */
194 /* OOM-Killer disable */
195 int oom_kill_disable;
197 /* handle for "memory.events" */
198 struct cgroup_file events_file;
200 /* protect arrays of thresholds */
201 struct mutex thresholds_lock;
203 /* thresholds for memory usage. RCU-protected */
204 struct mem_cgroup_thresholds thresholds;
206 /* thresholds for mem+swap usage. RCU-protected */
207 struct mem_cgroup_thresholds memsw_thresholds;
209 /* For oom notifier event fd */
210 struct list_head oom_notify;
213 * Should we move charges of a task when a task is moved into this
214 * mem_cgroup ? And what type of charges should we move ?
216 unsigned long move_charge_at_immigrate;
218 * set > 0 if pages under this cgroup are moving to other cgroup.
220 atomic_t moving_account;
221 /* taken only while moving_account > 0 */
222 spinlock_t move_lock;
223 struct task_struct *move_lock_task;
224 unsigned long move_lock_flags;
228 struct mem_cgroup_stat_cpu __percpu *stat;
230 #if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_INET)
231 struct cg_proto tcp_mem;
233 #if defined(CONFIG_MEMCG_KMEM)
234 /* Index in the kmem_cache->memcg_params.memcg_caches array */
236 bool kmem_acct_activated;
237 bool kmem_acct_active;
240 int last_scanned_node;
242 nodemask_t scan_nodes;
243 atomic_t numainfo_events;
244 atomic_t numainfo_updating;
247 #ifdef CONFIG_CGROUP_WRITEBACK
248 struct list_head cgwb_list;
249 struct wb_domain cgwb_domain;
253 unsigned long socket_pressure;
256 /* List of events which userspace want to receive */
257 struct list_head event_list;
258 spinlock_t event_list_lock;
260 struct mem_cgroup_per_node *nodeinfo[0];
261 /* WARNING: nodeinfo must be the last member here */
264 extern struct mem_cgroup *root_mem_cgroup;
267 * mem_cgroup_events - count memory events against a cgroup
268 * @memcg: the memory cgroup
269 * @idx: the event index
270 * @nr: the number of events to account for
272 static inline void mem_cgroup_events(struct mem_cgroup *memcg,
273 enum mem_cgroup_events_index idx,
276 this_cpu_add(memcg->stat->events[idx], nr);
277 cgroup_file_notify(&memcg->events_file);
280 bool mem_cgroup_low(struct mem_cgroup *root, struct mem_cgroup *memcg);
282 int mem_cgroup_try_charge(struct page *page, struct mm_struct *mm,
283 gfp_t gfp_mask, struct mem_cgroup **memcgp);
284 void mem_cgroup_commit_charge(struct page *page, struct mem_cgroup *memcg,
286 void mem_cgroup_cancel_charge(struct page *page, struct mem_cgroup *memcg);
287 void mem_cgroup_uncharge(struct page *page);
288 void mem_cgroup_uncharge_list(struct list_head *page_list);
290 void mem_cgroup_replace_page(struct page *oldpage, struct page *newpage);
292 struct lruvec *mem_cgroup_zone_lruvec(struct zone *, struct mem_cgroup *);
293 struct lruvec *mem_cgroup_page_lruvec(struct page *, struct zone *);
295 bool task_in_mem_cgroup(struct task_struct *task, struct mem_cgroup *memcg);
296 struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
299 struct mem_cgroup *mem_cgroup_from_css(struct cgroup_subsys_state *css){
300 return css ? container_of(css, struct mem_cgroup, css) : NULL;
303 #define mem_cgroup_from_counter(counter, member) \
304 container_of(counter, struct mem_cgroup, member)
306 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
308 struct mem_cgroup_reclaim_cookie *);
309 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
312 * parent_mem_cgroup - find the accounting parent of a memcg
313 * @memcg: memcg whose parent to find
315 * Returns the parent memcg, or NULL if this is the root or the memory
316 * controller is in legacy no-hierarchy mode.
318 static inline struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg)
320 if (!memcg->memory.parent)
322 return mem_cgroup_from_counter(memcg->memory.parent, memory);
325 static inline bool mem_cgroup_is_descendant(struct mem_cgroup *memcg,
326 struct mem_cgroup *root)
330 if (!root->use_hierarchy)
332 return cgroup_is_descendant(memcg->css.cgroup, root->css.cgroup);
335 static inline bool mm_match_cgroup(struct mm_struct *mm,
336 struct mem_cgroup *memcg)
338 struct mem_cgroup *task_memcg;
342 task_memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
344 match = mem_cgroup_is_descendant(task_memcg, memcg);
349 struct cgroup_subsys_state *mem_cgroup_css_from_page(struct page *page);
350 ino_t page_cgroup_ino(struct page *page);
352 static inline bool mem_cgroup_disabled(void)
354 return !cgroup_subsys_enabled(memory_cgrp_subsys);
358 * For memory reclaim.
360 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
362 void mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
365 static inline bool mem_cgroup_lruvec_online(struct lruvec *lruvec)
367 struct mem_cgroup_per_zone *mz;
368 struct mem_cgroup *memcg;
370 if (mem_cgroup_disabled())
373 mz = container_of(lruvec, struct mem_cgroup_per_zone, lruvec);
376 return !!(memcg->css.flags & CSS_ONLINE);
380 unsigned long mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list lru)
382 struct mem_cgroup_per_zone *mz;
384 mz = container_of(lruvec, struct mem_cgroup_per_zone, lruvec);
385 return mz->lru_size[lru];
388 static inline bool mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec)
390 unsigned long inactive_ratio;
391 unsigned long inactive;
392 unsigned long active;
395 inactive = mem_cgroup_get_lru_size(lruvec, LRU_INACTIVE_ANON);
396 active = mem_cgroup_get_lru_size(lruvec, LRU_ACTIVE_ANON);
398 gb = (inactive + active) >> (30 - PAGE_SHIFT);
400 inactive_ratio = int_sqrt(10 * gb);
404 return inactive * inactive_ratio < active;
407 void mem_cgroup_handle_over_high(void);
409 void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
410 struct task_struct *p);
412 static inline void mem_cgroup_oom_enable(void)
414 WARN_ON(current->memcg_may_oom);
415 current->memcg_may_oom = 1;
418 static inline void mem_cgroup_oom_disable(void)
420 WARN_ON(!current->memcg_may_oom);
421 current->memcg_may_oom = 0;
424 static inline bool task_in_memcg_oom(struct task_struct *p)
426 return p->memcg_in_oom;
429 bool mem_cgroup_oom_synchronize(bool wait);
431 #ifdef CONFIG_MEMCG_SWAP
432 extern int do_swap_account;
435 struct mem_cgroup *mem_cgroup_begin_page_stat(struct page *page);
436 void mem_cgroup_end_page_stat(struct mem_cgroup *memcg);
439 * mem_cgroup_update_page_stat - update page state statistics
440 * @memcg: memcg to account against
441 * @idx: page state item to account
442 * @val: number of pages (positive or negative)
444 * See mem_cgroup_begin_page_stat() for locking requirements.
446 static inline void mem_cgroup_update_page_stat(struct mem_cgroup *memcg,
447 enum mem_cgroup_stat_index idx, int val)
449 VM_BUG_ON(!rcu_read_lock_held());
452 this_cpu_add(memcg->stat->count[idx], val);
455 static inline void mem_cgroup_inc_page_stat(struct mem_cgroup *memcg,
456 enum mem_cgroup_stat_index idx)
458 mem_cgroup_update_page_stat(memcg, idx, 1);
461 static inline void mem_cgroup_dec_page_stat(struct mem_cgroup *memcg,
462 enum mem_cgroup_stat_index idx)
464 mem_cgroup_update_page_stat(memcg, idx, -1);
467 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
469 unsigned long *total_scanned);
471 static inline void mem_cgroup_count_vm_event(struct mm_struct *mm,
472 enum vm_event_item idx)
474 struct mem_cgroup *memcg;
476 if (mem_cgroup_disabled())
480 memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
481 if (unlikely(!memcg))
486 this_cpu_inc(memcg->stat->events[MEM_CGROUP_EVENTS_PGFAULT]);
489 this_cpu_inc(memcg->stat->events[MEM_CGROUP_EVENTS_PGMAJFAULT]);
497 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
498 void mem_cgroup_split_huge_fixup(struct page *head);
501 #else /* CONFIG_MEMCG */
504 static inline void mem_cgroup_events(struct mem_cgroup *memcg,
505 enum mem_cgroup_events_index idx,
510 static inline bool mem_cgroup_low(struct mem_cgroup *root,
511 struct mem_cgroup *memcg)
516 static inline int mem_cgroup_try_charge(struct page *page, struct mm_struct *mm,
518 struct mem_cgroup **memcgp)
524 static inline void mem_cgroup_commit_charge(struct page *page,
525 struct mem_cgroup *memcg,
530 static inline void mem_cgroup_cancel_charge(struct page *page,
531 struct mem_cgroup *memcg)
535 static inline void mem_cgroup_uncharge(struct page *page)
539 static inline void mem_cgroup_uncharge_list(struct list_head *page_list)
543 static inline void mem_cgroup_replace_page(struct page *old, struct page *new)
547 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
548 struct mem_cgroup *memcg)
550 return &zone->lruvec;
553 static inline struct lruvec *mem_cgroup_page_lruvec(struct page *page,
556 return &zone->lruvec;
559 static inline bool mm_match_cgroup(struct mm_struct *mm,
560 struct mem_cgroup *memcg)
565 static inline bool task_in_mem_cgroup(struct task_struct *task,
566 const struct mem_cgroup *memcg)
571 static inline struct mem_cgroup *
572 mem_cgroup_iter(struct mem_cgroup *root,
573 struct mem_cgroup *prev,
574 struct mem_cgroup_reclaim_cookie *reclaim)
579 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
580 struct mem_cgroup *prev)
584 static inline bool mem_cgroup_disabled(void)
590 mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec)
595 static inline bool mem_cgroup_lruvec_online(struct lruvec *lruvec)
600 static inline unsigned long
601 mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list lru)
607 mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
613 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
617 static inline struct mem_cgroup *mem_cgroup_begin_page_stat(struct page *page)
622 static inline void mem_cgroup_end_page_stat(struct mem_cgroup *memcg)
626 static inline void mem_cgroup_handle_over_high(void)
630 static inline void mem_cgroup_oom_enable(void)
634 static inline void mem_cgroup_oom_disable(void)
638 static inline bool task_in_memcg_oom(struct task_struct *p)
643 static inline bool mem_cgroup_oom_synchronize(bool wait)
648 static inline void mem_cgroup_inc_page_stat(struct mem_cgroup *memcg,
649 enum mem_cgroup_stat_index idx)
653 static inline void mem_cgroup_dec_page_stat(struct mem_cgroup *memcg,
654 enum mem_cgroup_stat_index idx)
659 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
661 unsigned long *total_scanned)
666 static inline void mem_cgroup_split_huge_fixup(struct page *head)
671 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
674 #endif /* CONFIG_MEMCG */
676 #ifdef CONFIG_CGROUP_WRITEBACK
678 struct list_head *mem_cgroup_cgwb_list(struct mem_cgroup *memcg);
679 struct wb_domain *mem_cgroup_wb_domain(struct bdi_writeback *wb);
680 void mem_cgroup_wb_stats(struct bdi_writeback *wb, unsigned long *pfilepages,
681 unsigned long *pheadroom, unsigned long *pdirty,
682 unsigned long *pwriteback);
684 #else /* CONFIG_CGROUP_WRITEBACK */
686 static inline struct wb_domain *mem_cgroup_wb_domain(struct bdi_writeback *wb)
691 static inline void mem_cgroup_wb_stats(struct bdi_writeback *wb,
692 unsigned long *pfilepages,
693 unsigned long *pheadroom,
694 unsigned long *pdirty,
695 unsigned long *pwriteback)
699 #endif /* CONFIG_CGROUP_WRITEBACK */
702 void sock_update_memcg(struct sock *sk);
703 void sock_release_memcg(struct sock *sk);
704 bool mem_cgroup_charge_skmem(struct mem_cgroup *memcg, unsigned int nr_pages);
705 void mem_cgroup_uncharge_skmem(struct mem_cgroup *memcg, unsigned int nr_pages);
706 #if defined(CONFIG_MEMCG) && defined(CONFIG_INET)
707 extern struct static_key_false memcg_sockets_enabled_key;
708 #define mem_cgroup_sockets_enabled static_branch_unlikely(&memcg_sockets_enabled_key)
709 static inline bool mem_cgroup_under_socket_pressure(struct mem_cgroup *memcg)
711 #ifdef CONFIG_MEMCG_KMEM
712 if (memcg->tcp_mem.memory_pressure)
716 if (time_before(jiffies, memcg->socket_pressure))
718 } while ((memcg = parent_mem_cgroup(memcg)));
722 #define mem_cgroup_sockets_enabled 0
723 static inline bool mem_cgroup_under_socket_pressure(struct mem_cgroup *memcg)
729 #ifdef CONFIG_MEMCG_KMEM
730 extern struct static_key_false memcg_kmem_enabled_key;
732 extern int memcg_nr_cache_ids;
733 void memcg_get_cache_ids(void);
734 void memcg_put_cache_ids(void);
737 * Helper macro to loop through all memcg-specific caches. Callers must still
738 * check if the cache is valid (it is either valid or NULL).
739 * the slab_mutex must be held when looping through those caches
741 #define for_each_memcg_cache_index(_idx) \
742 for ((_idx) = 0; (_idx) < memcg_nr_cache_ids; (_idx)++)
744 static inline bool memcg_kmem_enabled(void)
746 return static_branch_unlikely(&memcg_kmem_enabled_key);
749 static inline bool memcg_kmem_is_active(struct mem_cgroup *memcg)
751 return memcg->kmem_acct_active;
755 * In general, we'll do everything in our power to not incur in any overhead
756 * for non-memcg users for the kmem functions. Not even a function call, if we
759 * Therefore, we'll inline all those functions so that in the best case, we'll
760 * see that kmemcg is off for everybody and proceed quickly. If it is on,
761 * we'll still do most of the flag checking inline. We check a lot of
762 * conditions, but because they are pretty simple, they are expected to be
765 int __memcg_kmem_charge_memcg(struct page *page, gfp_t gfp, int order,
766 struct mem_cgroup *memcg);
767 int __memcg_kmem_charge(struct page *page, gfp_t gfp, int order);
768 void __memcg_kmem_uncharge(struct page *page, int order);
771 * helper for acessing a memcg's index. It will be used as an index in the
772 * child cache array in kmem_cache, and also to derive its name. This function
773 * will return -1 when this is not a kmem-limited memcg.
775 static inline int memcg_cache_id(struct mem_cgroup *memcg)
777 return memcg ? memcg->kmemcg_id : -1;
780 struct kmem_cache *__memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp);
781 void __memcg_kmem_put_cache(struct kmem_cache *cachep);
783 static inline bool __memcg_kmem_bypass(void)
785 if (!memcg_kmem_enabled())
787 if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
793 * memcg_kmem_charge: charge a kmem page
794 * @page: page to charge
796 * @order: allocation order
798 * Returns 0 on success, an error code on failure.
800 static __always_inline int memcg_kmem_charge(struct page *page,
801 gfp_t gfp, int order)
803 if (__memcg_kmem_bypass())
805 if (!(gfp & __GFP_ACCOUNT))
807 return __memcg_kmem_charge(page, gfp, order);
811 * memcg_kmem_uncharge: uncharge a kmem page
812 * @page: page to uncharge
813 * @order: allocation order
815 static __always_inline void memcg_kmem_uncharge(struct page *page, int order)
817 if (memcg_kmem_enabled())
818 __memcg_kmem_uncharge(page, order);
822 * memcg_kmem_get_cache: selects the correct per-memcg cache for allocation
823 * @cachep: the original global kmem cache
825 * All memory allocated from a per-memcg cache is charged to the owner memcg.
827 static __always_inline struct kmem_cache *
828 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
830 if (__memcg_kmem_bypass())
832 return __memcg_kmem_get_cache(cachep, gfp);
835 static __always_inline void memcg_kmem_put_cache(struct kmem_cache *cachep)
837 if (memcg_kmem_enabled())
838 __memcg_kmem_put_cache(cachep);
841 #define for_each_memcg_cache_index(_idx) \
844 static inline bool memcg_kmem_enabled(void)
849 static inline bool memcg_kmem_is_active(struct mem_cgroup *memcg)
854 static inline int memcg_kmem_charge(struct page *page, gfp_t gfp, int order)
859 static inline void memcg_kmem_uncharge(struct page *page, int order)
863 static inline int memcg_cache_id(struct mem_cgroup *memcg)
868 static inline void memcg_get_cache_ids(void)
872 static inline void memcg_put_cache_ids(void)
876 static inline struct kmem_cache *
877 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
882 static inline void memcg_kmem_put_cache(struct kmem_cache *cachep)
885 #endif /* CONFIG_MEMCG_KMEM */
886 #endif /* _LINUX_MEMCONTROL_H */