1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* memcontrol.h - Memory Controller
4 * Copyright IBM Corporation, 2007
7 * Copyright 2007 OpenVZ SWsoft Inc
11 #ifndef _LINUX_MEMCONTROL_H
12 #define _LINUX_MEMCONTROL_H
13 #include <linux/cgroup.h>
14 #include <linux/vm_event_item.h>
15 #include <linux/hardirq.h>
16 #include <linux/jump_label.h>
17 #include <linux/page_counter.h>
18 #include <linux/vmpressure.h>
19 #include <linux/eventfd.h>
21 #include <linux/vmstat.h>
22 #include <linux/writeback.h>
23 #include <linux/page-flags.h>
31 /* Cgroup-specific page state, on top of universal node page state */
32 enum memcg_stat_item {
33 MEMCG_SWAP = NR_VM_NODE_STAT_ITEMS,
41 enum memcg_memory_event {
51 MEMCG_NR_MEMORY_EVENTS,
54 struct mem_cgroup_reclaim_cookie {
56 unsigned int generation;
61 #define MEM_CGROUP_ID_SHIFT 16
62 #define MEM_CGROUP_ID_MAX USHRT_MAX
64 struct mem_cgroup_id {
70 * Per memcg event counter is incremented at every pagein/pageout. With THP,
71 * it will be incremented by the number of pages. This counter is used
72 * to trigger some periodic events. This is straightforward and better
73 * than using jiffies etc. to handle periodic memcg event.
75 enum mem_cgroup_events_target {
76 MEM_CGROUP_TARGET_THRESH,
77 MEM_CGROUP_TARGET_SOFTLIMIT,
81 struct memcg_vmstats_percpu {
82 /* Local (CPU and cgroup) page state & events */
83 long state[MEMCG_NR_STAT];
84 unsigned long events[NR_VM_EVENT_ITEMS];
86 /* Delta calculation for lockless upward propagation */
87 long state_prev[MEMCG_NR_STAT];
88 unsigned long events_prev[NR_VM_EVENT_ITEMS];
90 /* Cgroup1: threshold notifications & softlimit tree updates */
91 unsigned long nr_page_events;
92 unsigned long targets[MEM_CGROUP_NTARGETS];
95 struct memcg_vmstats {
96 /* Aggregated (CPU and subtree) page state & events */
97 long state[MEMCG_NR_STAT];
98 unsigned long events[NR_VM_EVENT_ITEMS];
100 /* Pending child counts during tree propagation */
101 long state_pending[MEMCG_NR_STAT];
102 unsigned long events_pending[NR_VM_EVENT_ITEMS];
105 struct mem_cgroup_reclaim_iter {
106 struct mem_cgroup *position;
107 /* scan generation, increased every round-trip */
108 unsigned int generation;
112 * Bitmap and deferred work of shrinker::id corresponding to memcg-aware
113 * shrinkers, which have elements charged to this memcg.
115 struct shrinker_info {
117 atomic_long_t *nr_deferred;
121 struct lruvec_stats_percpu {
122 /* Local (CPU and cgroup) state */
123 long state[NR_VM_NODE_STAT_ITEMS];
125 /* Delta calculation for lockless upward propagation */
126 long state_prev[NR_VM_NODE_STAT_ITEMS];
129 struct lruvec_stats {
130 /* Aggregated (CPU and subtree) state */
131 long state[NR_VM_NODE_STAT_ITEMS];
133 /* Pending child counts during tree propagation */
134 long state_pending[NR_VM_NODE_STAT_ITEMS];
138 * per-node information in memory controller.
140 struct mem_cgroup_per_node {
141 struct lruvec lruvec;
143 struct lruvec_stats_percpu __percpu *lruvec_stats_percpu;
144 struct lruvec_stats lruvec_stats;
146 unsigned long lru_zone_size[MAX_NR_ZONES][NR_LRU_LISTS];
148 struct mem_cgroup_reclaim_iter iter;
150 struct shrinker_info __rcu *shrinker_info;
152 struct rb_node tree_node; /* RB tree node */
153 unsigned long usage_in_excess;/* Set to the value by which */
154 /* the soft limit is exceeded*/
156 struct mem_cgroup *memcg; /* Back pointer, we cannot */
157 /* use container_of */
160 struct mem_cgroup_threshold {
161 struct eventfd_ctx *eventfd;
162 unsigned long threshold;
166 struct mem_cgroup_threshold_ary {
167 /* An array index points to threshold just below or equal to usage. */
168 int current_threshold;
169 /* Size of entries[] */
171 /* Array of thresholds */
172 struct mem_cgroup_threshold entries[];
175 struct mem_cgroup_thresholds {
176 /* Primary thresholds array */
177 struct mem_cgroup_threshold_ary *primary;
179 * Spare threshold array.
180 * This is needed to make mem_cgroup_unregister_event() "never fail".
181 * It must be able to store at least primary->size - 1 entries.
183 struct mem_cgroup_threshold_ary *spare;
186 #if defined(CONFIG_SMP)
187 struct memcg_padding {
189 } ____cacheline_internodealigned_in_smp;
190 #define MEMCG_PADDING(name) struct memcg_padding name
192 #define MEMCG_PADDING(name)
196 * Remember four most recent foreign writebacks with dirty pages in this
197 * cgroup. Inode sharing is expected to be uncommon and, even if we miss
198 * one in a given round, we're likely to catch it later if it keeps
199 * foreign-dirtying, so a fairly low count should be enough.
201 * See mem_cgroup_track_foreign_dirty_slowpath() for details.
203 #define MEMCG_CGWB_FRN_CNT 4
205 struct memcg_cgwb_frn {
206 u64 bdi_id; /* bdi->id of the foreign inode */
207 int memcg_id; /* memcg->css.id of foreign inode */
208 u64 at; /* jiffies_64 at the time of dirtying */
209 struct wb_completion done; /* tracks in-flight foreign writebacks */
213 * Bucket for arbitrarily byte-sized objects charged to a memory
214 * cgroup. The bucket can be reparented in one piece when the cgroup
215 * is destroyed, without having to round up the individual references
216 * of all live memory objects in the wild.
219 struct percpu_ref refcnt;
220 struct mem_cgroup *memcg;
221 atomic_t nr_charged_bytes;
223 struct list_head list; /* protected by objcg_lock */
229 * The memory controller data structure. The memory controller controls both
230 * page cache and RSS per cgroup. We would eventually like to provide
231 * statistics based on the statistics developed by Rik Van Riel for clock-pro,
232 * to help the administrator determine what knobs to tune.
235 struct cgroup_subsys_state css;
237 /* Private memcg ID. Used to ID objects that outlive the cgroup */
238 struct mem_cgroup_id id;
240 /* Accounted resources */
241 struct page_counter memory; /* Both v1 & v2 */
244 struct page_counter swap; /* v2 only */
245 struct page_counter memsw; /* v1 only */
248 /* Legacy consumer-oriented counters */
249 struct page_counter kmem; /* v1 only */
250 struct page_counter tcpmem; /* v1 only */
252 /* Range enforcement for interrupt charges */
253 struct work_struct high_work;
255 unsigned long soft_limit;
257 /* vmpressure notifications */
258 struct vmpressure vmpressure;
261 * Should the OOM killer kill all belonging tasks, had it kill one?
265 /* protected by memcg_oom_lock */
270 /* OOM-Killer disable */
271 int oom_kill_disable;
273 /* memory.events and memory.events.local */
274 struct cgroup_file events_file;
275 struct cgroup_file events_local_file;
277 /* handle for "memory.swap.events" */
278 struct cgroup_file swap_events_file;
280 /* protect arrays of thresholds */
281 struct mutex thresholds_lock;
283 /* thresholds for memory usage. RCU-protected */
284 struct mem_cgroup_thresholds thresholds;
286 /* thresholds for mem+swap usage. RCU-protected */
287 struct mem_cgroup_thresholds memsw_thresholds;
289 /* For oom notifier event fd */
290 struct list_head oom_notify;
293 * Should we move charges of a task when a task is moved into this
294 * mem_cgroup ? And what type of charges should we move ?
296 unsigned long move_charge_at_immigrate;
297 /* taken only while moving_account > 0 */
298 spinlock_t move_lock;
299 unsigned long move_lock_flags;
301 MEMCG_PADDING(_pad1_);
304 struct memcg_vmstats vmstats;
307 atomic_long_t memory_events[MEMCG_NR_MEMORY_EVENTS];
308 atomic_long_t memory_events_local[MEMCG_NR_MEMORY_EVENTS];
310 unsigned long socket_pressure;
312 /* Legacy tcp memory accounting */
316 #ifdef CONFIG_MEMCG_KMEM
318 struct obj_cgroup __rcu *objcg;
319 /* list of inherited objcgs, protected by objcg_lock */
320 struct list_head objcg_list;
323 MEMCG_PADDING(_pad2_);
326 * set > 0 if pages under this cgroup are moving to other cgroup.
328 atomic_t moving_account;
329 struct task_struct *move_lock_task;
331 struct memcg_vmstats_percpu __percpu *vmstats_percpu;
333 #ifdef CONFIG_CGROUP_WRITEBACK
334 struct list_head cgwb_list;
335 struct wb_domain cgwb_domain;
336 struct memcg_cgwb_frn cgwb_frn[MEMCG_CGWB_FRN_CNT];
339 /* List of events which userspace want to receive */
340 struct list_head event_list;
341 spinlock_t event_list_lock;
343 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
344 struct deferred_split deferred_split_queue;
347 struct mem_cgroup_per_node *nodeinfo[];
351 * size of first charge trial. "32" comes from vmscan.c's magic value.
352 * TODO: maybe necessary to use big numbers in big irons.
354 #define MEMCG_CHARGE_BATCH 32U
356 extern struct mem_cgroup *root_mem_cgroup;
358 enum page_memcg_data_flags {
359 /* page->memcg_data is a pointer to an objcgs vector */
360 MEMCG_DATA_OBJCGS = (1UL << 0),
361 /* page has been accounted as a non-slab kernel page */
362 MEMCG_DATA_KMEM = (1UL << 1),
363 /* the next bit after the last actual flag */
364 __NR_MEMCG_DATA_FLAGS = (1UL << 2),
367 #define MEMCG_DATA_FLAGS_MASK (__NR_MEMCG_DATA_FLAGS - 1)
369 static inline bool folio_memcg_kmem(struct folio *folio);
372 * After the initialization objcg->memcg is always pointing at
373 * a valid memcg, but can be atomically swapped to the parent memcg.
375 * The caller must ensure that the returned memcg won't be released:
376 * e.g. acquire the rcu_read_lock or css_set_lock.
378 static inline struct mem_cgroup *obj_cgroup_memcg(struct obj_cgroup *objcg)
380 return READ_ONCE(objcg->memcg);
384 * __folio_memcg - Get the memory cgroup associated with a non-kmem folio
385 * @folio: Pointer to the folio.
387 * Returns a pointer to the memory cgroup associated with the folio,
388 * or NULL. This function assumes that the folio is known to have a
389 * proper memory cgroup pointer. It's not safe to call this function
390 * against some type of folios, e.g. slab folios or ex-slab folios or
393 static inline struct mem_cgroup *__folio_memcg(struct folio *folio)
395 unsigned long memcg_data = folio->memcg_data;
397 VM_BUG_ON_FOLIO(folio_test_slab(folio), folio);
398 VM_BUG_ON_FOLIO(memcg_data & MEMCG_DATA_OBJCGS, folio);
399 VM_BUG_ON_FOLIO(memcg_data & MEMCG_DATA_KMEM, folio);
401 return (struct mem_cgroup *)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
405 * __folio_objcg - get the object cgroup associated with a kmem folio.
406 * @folio: Pointer to the folio.
408 * Returns a pointer to the object cgroup associated with the folio,
409 * or NULL. This function assumes that the folio is known to have a
410 * proper object cgroup pointer. It's not safe to call this function
411 * against some type of folios, e.g. slab folios or ex-slab folios or
414 static inline struct obj_cgroup *__folio_objcg(struct folio *folio)
416 unsigned long memcg_data = folio->memcg_data;
418 VM_BUG_ON_FOLIO(folio_test_slab(folio), folio);
419 VM_BUG_ON_FOLIO(memcg_data & MEMCG_DATA_OBJCGS, folio);
420 VM_BUG_ON_FOLIO(!(memcg_data & MEMCG_DATA_KMEM), folio);
422 return (struct obj_cgroup *)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
426 * folio_memcg - Get the memory cgroup associated with a folio.
427 * @folio: Pointer to the folio.
429 * Returns a pointer to the memory cgroup associated with the folio,
430 * or NULL. This function assumes that the folio is known to have a
431 * proper memory cgroup pointer. It's not safe to call this function
432 * against some type of folios, e.g. slab folios or ex-slab folios.
434 * For a non-kmem folio any of the following ensures folio and memcg binding
439 * - lock_page_memcg()
440 * - exclusive reference
442 * For a kmem folio a caller should hold an rcu read lock to protect memcg
443 * associated with a kmem folio from being released.
445 static inline struct mem_cgroup *folio_memcg(struct folio *folio)
447 if (folio_memcg_kmem(folio))
448 return obj_cgroup_memcg(__folio_objcg(folio));
449 return __folio_memcg(folio);
452 static inline struct mem_cgroup *page_memcg(struct page *page)
454 return folio_memcg(page_folio(page));
458 * folio_memcg_rcu - Locklessly get the memory cgroup associated with a folio.
459 * @folio: Pointer to the folio.
461 * This function assumes that the folio is known to have a
462 * proper memory cgroup pointer. It's not safe to call this function
463 * against some type of folios, e.g. slab folios or ex-slab folios.
465 * Return: A pointer to the memory cgroup associated with the folio,
468 static inline struct mem_cgroup *folio_memcg_rcu(struct folio *folio)
470 unsigned long memcg_data = READ_ONCE(folio->memcg_data);
472 VM_BUG_ON_FOLIO(folio_test_slab(folio), folio);
473 WARN_ON_ONCE(!rcu_read_lock_held());
475 if (memcg_data & MEMCG_DATA_KMEM) {
476 struct obj_cgroup *objcg;
478 objcg = (void *)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
479 return obj_cgroup_memcg(objcg);
482 return (struct mem_cgroup *)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
486 * page_memcg_check - get the memory cgroup associated with a page
487 * @page: a pointer to the page struct
489 * Returns a pointer to the memory cgroup associated with the page,
490 * or NULL. This function unlike page_memcg() can take any page
491 * as an argument. It has to be used in cases when it's not known if a page
492 * has an associated memory cgroup pointer or an object cgroups vector or
495 * For a non-kmem page any of the following ensures page and memcg binding
500 * - lock_page_memcg()
501 * - exclusive reference
503 * For a kmem page a caller should hold an rcu read lock to protect memcg
504 * associated with a kmem page from being released.
506 static inline struct mem_cgroup *page_memcg_check(struct page *page)
509 * Because page->memcg_data might be changed asynchronously
510 * for slab pages, READ_ONCE() should be used here.
512 unsigned long memcg_data = READ_ONCE(page->memcg_data);
514 if (memcg_data & MEMCG_DATA_OBJCGS)
517 if (memcg_data & MEMCG_DATA_KMEM) {
518 struct obj_cgroup *objcg;
520 objcg = (void *)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
521 return obj_cgroup_memcg(objcg);
524 return (struct mem_cgroup *)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
527 static inline struct mem_cgroup *get_mem_cgroup_from_objcg(struct obj_cgroup *objcg)
529 struct mem_cgroup *memcg;
533 memcg = obj_cgroup_memcg(objcg);
534 if (unlikely(!css_tryget(&memcg->css)))
541 #ifdef CONFIG_MEMCG_KMEM
543 * folio_memcg_kmem - Check if the folio has the memcg_kmem flag set.
544 * @folio: Pointer to the folio.
546 * Checks if the folio has MemcgKmem flag set. The caller must ensure
547 * that the folio has an associated memory cgroup. It's not safe to call
548 * this function against some types of folios, e.g. slab folios.
550 static inline bool folio_memcg_kmem(struct folio *folio)
552 VM_BUG_ON_PGFLAGS(PageTail(&folio->page), &folio->page);
553 VM_BUG_ON_FOLIO(folio->memcg_data & MEMCG_DATA_OBJCGS, folio);
554 return folio->memcg_data & MEMCG_DATA_KMEM;
559 static inline bool folio_memcg_kmem(struct folio *folio)
566 static inline bool PageMemcgKmem(struct page *page)
568 return folio_memcg_kmem(page_folio(page));
571 static inline bool mem_cgroup_is_root(struct mem_cgroup *memcg)
573 return (memcg == root_mem_cgroup);
576 static inline bool mem_cgroup_disabled(void)
578 return !cgroup_subsys_enabled(memory_cgrp_subsys);
581 static inline void mem_cgroup_protection(struct mem_cgroup *root,
582 struct mem_cgroup *memcg,
588 if (mem_cgroup_disabled())
592 * There is no reclaim protection applied to a targeted reclaim.
593 * We are special casing this specific case here because
594 * mem_cgroup_protected calculation is not robust enough to keep
595 * the protection invariant for calculated effective values for
596 * parallel reclaimers with different reclaim target. This is
597 * especially a problem for tail memcgs (as they have pages on LRU)
598 * which would want to have effective values 0 for targeted reclaim
599 * but a different value for external reclaim.
602 * Let's have global and A's reclaim in parallel:
604 * A (low=2G, usage = 3G, max = 3G, children_low_usage = 1.5G)
606 * | C (low = 1G, usage = 2.5G)
607 * B (low = 1G, usage = 0.5G)
609 * For the global reclaim
611 * B.elow = min(B.usage, B.low) because children_low_usage <= A.elow
612 * C.elow = min(C.usage, C.low)
614 * With the effective values resetting we have A reclaim
619 * If the global reclaim races with A's reclaim then
620 * B.elow = C.elow = 0 because children_low_usage > A.elow)
621 * is possible and reclaiming B would be violating the protection.
627 *min = READ_ONCE(memcg->memory.emin);
628 *low = READ_ONCE(memcg->memory.elow);
631 void mem_cgroup_calculate_protection(struct mem_cgroup *root,
632 struct mem_cgroup *memcg);
634 static inline bool mem_cgroup_supports_protection(struct mem_cgroup *memcg)
637 * The root memcg doesn't account charges, and doesn't support
640 return !mem_cgroup_disabled() && !mem_cgroup_is_root(memcg);
644 static inline bool mem_cgroup_below_low(struct mem_cgroup *memcg)
646 if (!mem_cgroup_supports_protection(memcg))
649 return READ_ONCE(memcg->memory.elow) >=
650 page_counter_read(&memcg->memory);
653 static inline bool mem_cgroup_below_min(struct mem_cgroup *memcg)
655 if (!mem_cgroup_supports_protection(memcg))
658 return READ_ONCE(memcg->memory.emin) >=
659 page_counter_read(&memcg->memory);
662 int __mem_cgroup_charge(struct folio *folio, struct mm_struct *mm, gfp_t gfp);
665 * mem_cgroup_charge - Charge a newly allocated folio to a cgroup.
666 * @folio: Folio to charge.
667 * @mm: mm context of the allocating task.
668 * @gfp: Reclaim mode.
670 * Try to charge @folio to the memcg that @mm belongs to, reclaiming
671 * pages according to @gfp if necessary. If @mm is NULL, try to
672 * charge to the active memcg.
674 * Do not use this for folios allocated for swapin.
676 * Return: 0 on success. Otherwise, an error code is returned.
678 static inline int mem_cgroup_charge(struct folio *folio, struct mm_struct *mm,
681 if (mem_cgroup_disabled())
683 return __mem_cgroup_charge(folio, mm, gfp);
686 int mem_cgroup_swapin_charge_page(struct page *page, struct mm_struct *mm,
687 gfp_t gfp, swp_entry_t entry);
688 void mem_cgroup_swapin_uncharge_swap(swp_entry_t entry);
690 void __mem_cgroup_uncharge(struct folio *folio);
693 * mem_cgroup_uncharge - Uncharge a folio.
694 * @folio: Folio to uncharge.
696 * Uncharge a folio previously charged with mem_cgroup_charge().
698 static inline void mem_cgroup_uncharge(struct folio *folio)
700 if (mem_cgroup_disabled())
702 __mem_cgroup_uncharge(folio);
705 void __mem_cgroup_uncharge_list(struct list_head *page_list);
706 static inline void mem_cgroup_uncharge_list(struct list_head *page_list)
708 if (mem_cgroup_disabled())
710 __mem_cgroup_uncharge_list(page_list);
713 void mem_cgroup_migrate(struct folio *old, struct folio *new);
716 * mem_cgroup_lruvec - get the lru list vector for a memcg & node
717 * @memcg: memcg of the wanted lruvec
718 * @pgdat: pglist_data
720 * Returns the lru list vector holding pages for a given @memcg &
721 * @pgdat combination. This can be the node lruvec, if the memory
722 * controller is disabled.
724 static inline struct lruvec *mem_cgroup_lruvec(struct mem_cgroup *memcg,
725 struct pglist_data *pgdat)
727 struct mem_cgroup_per_node *mz;
728 struct lruvec *lruvec;
730 if (mem_cgroup_disabled()) {
731 lruvec = &pgdat->__lruvec;
736 memcg = root_mem_cgroup;
738 mz = memcg->nodeinfo[pgdat->node_id];
739 lruvec = &mz->lruvec;
742 * Since a node can be onlined after the mem_cgroup was created,
743 * we have to be prepared to initialize lruvec->pgdat here;
744 * and if offlined then reonlined, we need to reinitialize it.
746 if (unlikely(lruvec->pgdat != pgdat))
747 lruvec->pgdat = pgdat;
752 * folio_lruvec - return lruvec for isolating/putting an LRU folio
753 * @folio: Pointer to the folio.
755 * This function relies on folio->mem_cgroup being stable.
757 static inline struct lruvec *folio_lruvec(struct folio *folio)
759 struct mem_cgroup *memcg = folio_memcg(folio);
761 VM_WARN_ON_ONCE_FOLIO(!memcg && !mem_cgroup_disabled(), folio);
762 return mem_cgroup_lruvec(memcg, folio_pgdat(folio));
765 struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
767 struct mem_cgroup *get_mem_cgroup_from_mm(struct mm_struct *mm);
769 struct lruvec *folio_lruvec_lock(struct folio *folio);
770 struct lruvec *folio_lruvec_lock_irq(struct folio *folio);
771 struct lruvec *folio_lruvec_lock_irqsave(struct folio *folio,
772 unsigned long *flags);
774 #ifdef CONFIG_DEBUG_VM
775 void lruvec_memcg_debug(struct lruvec *lruvec, struct folio *folio);
778 void lruvec_memcg_debug(struct lruvec *lruvec, struct folio *folio)
784 struct mem_cgroup *mem_cgroup_from_css(struct cgroup_subsys_state *css){
785 return css ? container_of(css, struct mem_cgroup, css) : NULL;
788 static inline bool obj_cgroup_tryget(struct obj_cgroup *objcg)
790 return percpu_ref_tryget(&objcg->refcnt);
793 static inline void obj_cgroup_get(struct obj_cgroup *objcg)
795 percpu_ref_get(&objcg->refcnt);
798 static inline void obj_cgroup_get_many(struct obj_cgroup *objcg,
801 percpu_ref_get_many(&objcg->refcnt, nr);
804 static inline void obj_cgroup_put(struct obj_cgroup *objcg)
806 percpu_ref_put(&objcg->refcnt);
809 static inline void mem_cgroup_put(struct mem_cgroup *memcg)
812 css_put(&memcg->css);
815 #define mem_cgroup_from_counter(counter, member) \
816 container_of(counter, struct mem_cgroup, member)
818 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
820 struct mem_cgroup_reclaim_cookie *);
821 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
822 int mem_cgroup_scan_tasks(struct mem_cgroup *,
823 int (*)(struct task_struct *, void *), void *);
825 static inline unsigned short mem_cgroup_id(struct mem_cgroup *memcg)
827 if (mem_cgroup_disabled())
832 struct mem_cgroup *mem_cgroup_from_id(unsigned short id);
834 static inline struct mem_cgroup *mem_cgroup_from_seq(struct seq_file *m)
836 return mem_cgroup_from_css(seq_css(m));
839 static inline struct mem_cgroup *lruvec_memcg(struct lruvec *lruvec)
841 struct mem_cgroup_per_node *mz;
843 if (mem_cgroup_disabled())
846 mz = container_of(lruvec, struct mem_cgroup_per_node, lruvec);
851 * parent_mem_cgroup - find the accounting parent of a memcg
852 * @memcg: memcg whose parent to find
854 * Returns the parent memcg, or NULL if this is the root or the memory
855 * controller is in legacy no-hierarchy mode.
857 static inline struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg)
859 return mem_cgroup_from_css(memcg->css.parent);
862 static inline bool mem_cgroup_is_descendant(struct mem_cgroup *memcg,
863 struct mem_cgroup *root)
867 return cgroup_is_descendant(memcg->css.cgroup, root->css.cgroup);
870 static inline bool mm_match_cgroup(struct mm_struct *mm,
871 struct mem_cgroup *memcg)
873 struct mem_cgroup *task_memcg;
877 task_memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
879 match = mem_cgroup_is_descendant(task_memcg, memcg);
884 struct cgroup_subsys_state *mem_cgroup_css_from_page(struct page *page);
885 ino_t page_cgroup_ino(struct page *page);
887 static inline bool mem_cgroup_online(struct mem_cgroup *memcg)
889 if (mem_cgroup_disabled())
891 return !!(memcg->css.flags & CSS_ONLINE);
894 void mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
895 int zid, int nr_pages);
898 unsigned long mem_cgroup_get_zone_lru_size(struct lruvec *lruvec,
899 enum lru_list lru, int zone_idx)
901 struct mem_cgroup_per_node *mz;
903 mz = container_of(lruvec, struct mem_cgroup_per_node, lruvec);
904 return READ_ONCE(mz->lru_zone_size[zone_idx][lru]);
907 void mem_cgroup_handle_over_high(void);
909 unsigned long mem_cgroup_get_max(struct mem_cgroup *memcg);
911 unsigned long mem_cgroup_size(struct mem_cgroup *memcg);
913 void mem_cgroup_print_oom_context(struct mem_cgroup *memcg,
914 struct task_struct *p);
916 void mem_cgroup_print_oom_meminfo(struct mem_cgroup *memcg);
918 static inline void mem_cgroup_enter_user_fault(void)
920 WARN_ON(current->in_user_fault);
921 current->in_user_fault = 1;
924 static inline void mem_cgroup_exit_user_fault(void)
926 WARN_ON(!current->in_user_fault);
927 current->in_user_fault = 0;
930 static inline bool task_in_memcg_oom(struct task_struct *p)
932 return p->memcg_in_oom;
935 bool mem_cgroup_oom_synchronize(bool wait);
936 struct mem_cgroup *mem_cgroup_get_oom_group(struct task_struct *victim,
937 struct mem_cgroup *oom_domain);
938 void mem_cgroup_print_oom_group(struct mem_cgroup *memcg);
940 #ifdef CONFIG_MEMCG_SWAP
941 extern bool cgroup_memory_noswap;
944 void folio_memcg_lock(struct folio *folio);
945 void folio_memcg_unlock(struct folio *folio);
946 void lock_page_memcg(struct page *page);
947 void unlock_page_memcg(struct page *page);
949 void __mod_memcg_state(struct mem_cgroup *memcg, int idx, int val);
951 /* idx can be of type enum memcg_stat_item or node_stat_item */
952 static inline void mod_memcg_state(struct mem_cgroup *memcg,
957 local_irq_save(flags);
958 __mod_memcg_state(memcg, idx, val);
959 local_irq_restore(flags);
962 static inline void mod_memcg_page_state(struct page *page,
965 struct mem_cgroup *memcg;
967 if (mem_cgroup_disabled())
971 memcg = page_memcg(page);
973 mod_memcg_state(memcg, idx, val);
977 static inline unsigned long memcg_page_state(struct mem_cgroup *memcg, int idx)
979 return READ_ONCE(memcg->vmstats.state[idx]);
982 static inline unsigned long lruvec_page_state(struct lruvec *lruvec,
983 enum node_stat_item idx)
985 struct mem_cgroup_per_node *pn;
987 if (mem_cgroup_disabled())
988 return node_page_state(lruvec_pgdat(lruvec), idx);
990 pn = container_of(lruvec, struct mem_cgroup_per_node, lruvec);
991 return READ_ONCE(pn->lruvec_stats.state[idx]);
994 static inline unsigned long lruvec_page_state_local(struct lruvec *lruvec,
995 enum node_stat_item idx)
997 struct mem_cgroup_per_node *pn;
1001 if (mem_cgroup_disabled())
1002 return node_page_state(lruvec_pgdat(lruvec), idx);
1004 pn = container_of(lruvec, struct mem_cgroup_per_node, lruvec);
1005 for_each_possible_cpu(cpu)
1006 x += per_cpu(pn->lruvec_stats_percpu->state[idx], cpu);
1014 void mem_cgroup_flush_stats(void);
1015 void mem_cgroup_flush_stats_delayed(void);
1017 void __mod_memcg_lruvec_state(struct lruvec *lruvec, enum node_stat_item idx,
1019 void __mod_lruvec_kmem_state(void *p, enum node_stat_item idx, int val);
1021 static inline void mod_lruvec_kmem_state(void *p, enum node_stat_item idx,
1024 unsigned long flags;
1026 local_irq_save(flags);
1027 __mod_lruvec_kmem_state(p, idx, val);
1028 local_irq_restore(flags);
1031 static inline void mod_memcg_lruvec_state(struct lruvec *lruvec,
1032 enum node_stat_item idx, int val)
1034 unsigned long flags;
1036 local_irq_save(flags);
1037 __mod_memcg_lruvec_state(lruvec, idx, val);
1038 local_irq_restore(flags);
1041 void __count_memcg_events(struct mem_cgroup *memcg, enum vm_event_item idx,
1042 unsigned long count);
1044 static inline void count_memcg_events(struct mem_cgroup *memcg,
1045 enum vm_event_item idx,
1046 unsigned long count)
1048 unsigned long flags;
1050 local_irq_save(flags);
1051 __count_memcg_events(memcg, idx, count);
1052 local_irq_restore(flags);
1055 static inline void count_memcg_page_event(struct page *page,
1056 enum vm_event_item idx)
1058 struct mem_cgroup *memcg = page_memcg(page);
1061 count_memcg_events(memcg, idx, 1);
1064 static inline void count_memcg_event_mm(struct mm_struct *mm,
1065 enum vm_event_item idx)
1067 struct mem_cgroup *memcg;
1069 if (mem_cgroup_disabled())
1073 memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
1075 count_memcg_events(memcg, idx, 1);
1079 static inline void memcg_memory_event(struct mem_cgroup *memcg,
1080 enum memcg_memory_event event)
1082 bool swap_event = event == MEMCG_SWAP_HIGH || event == MEMCG_SWAP_MAX ||
1083 event == MEMCG_SWAP_FAIL;
1085 atomic_long_inc(&memcg->memory_events_local[event]);
1087 cgroup_file_notify(&memcg->events_local_file);
1090 atomic_long_inc(&memcg->memory_events[event]);
1092 cgroup_file_notify(&memcg->swap_events_file);
1094 cgroup_file_notify(&memcg->events_file);
1096 if (!cgroup_subsys_on_dfl(memory_cgrp_subsys))
1098 if (cgrp_dfl_root.flags & CGRP_ROOT_MEMORY_LOCAL_EVENTS)
1100 } while ((memcg = parent_mem_cgroup(memcg)) &&
1101 !mem_cgroup_is_root(memcg));
1104 static inline void memcg_memory_event_mm(struct mm_struct *mm,
1105 enum memcg_memory_event event)
1107 struct mem_cgroup *memcg;
1109 if (mem_cgroup_disabled())
1113 memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
1115 memcg_memory_event(memcg, event);
1119 void split_page_memcg(struct page *head, unsigned int nr);
1121 unsigned long mem_cgroup_soft_limit_reclaim(pg_data_t *pgdat, int order,
1123 unsigned long *total_scanned);
1125 #else /* CONFIG_MEMCG */
1127 #define MEM_CGROUP_ID_SHIFT 0
1128 #define MEM_CGROUP_ID_MAX 0
1130 static inline struct mem_cgroup *folio_memcg(struct folio *folio)
1135 static inline struct mem_cgroup *page_memcg(struct page *page)
1140 static inline struct mem_cgroup *folio_memcg_rcu(struct folio *folio)
1142 WARN_ON_ONCE(!rcu_read_lock_held());
1146 static inline struct mem_cgroup *page_memcg_check(struct page *page)
1151 static inline bool folio_memcg_kmem(struct folio *folio)
1156 static inline bool PageMemcgKmem(struct page *page)
1161 static inline bool mem_cgroup_is_root(struct mem_cgroup *memcg)
1166 static inline bool mem_cgroup_disabled(void)
1171 static inline void memcg_memory_event(struct mem_cgroup *memcg,
1172 enum memcg_memory_event event)
1176 static inline void memcg_memory_event_mm(struct mm_struct *mm,
1177 enum memcg_memory_event event)
1181 static inline void mem_cgroup_protection(struct mem_cgroup *root,
1182 struct mem_cgroup *memcg,
1189 static inline void mem_cgroup_calculate_protection(struct mem_cgroup *root,
1190 struct mem_cgroup *memcg)
1194 static inline bool mem_cgroup_below_low(struct mem_cgroup *memcg)
1199 static inline bool mem_cgroup_below_min(struct mem_cgroup *memcg)
1204 static inline int mem_cgroup_charge(struct folio *folio,
1205 struct mm_struct *mm, gfp_t gfp)
1210 static inline int mem_cgroup_swapin_charge_page(struct page *page,
1211 struct mm_struct *mm, gfp_t gfp, swp_entry_t entry)
1216 static inline void mem_cgroup_swapin_uncharge_swap(swp_entry_t entry)
1220 static inline void mem_cgroup_uncharge(struct folio *folio)
1224 static inline void mem_cgroup_uncharge_list(struct list_head *page_list)
1228 static inline void mem_cgroup_migrate(struct folio *old, struct folio *new)
1232 static inline struct lruvec *mem_cgroup_lruvec(struct mem_cgroup *memcg,
1233 struct pglist_data *pgdat)
1235 return &pgdat->__lruvec;
1238 static inline struct lruvec *folio_lruvec(struct folio *folio)
1240 struct pglist_data *pgdat = folio_pgdat(folio);
1241 return &pgdat->__lruvec;
1245 void lruvec_memcg_debug(struct lruvec *lruvec, struct folio *folio)
1249 static inline struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg)
1254 static inline bool mm_match_cgroup(struct mm_struct *mm,
1255 struct mem_cgroup *memcg)
1260 static inline struct mem_cgroup *get_mem_cgroup_from_mm(struct mm_struct *mm)
1266 struct mem_cgroup *mem_cgroup_from_css(struct cgroup_subsys_state *css)
1271 static inline void mem_cgroup_put(struct mem_cgroup *memcg)
1275 static inline struct lruvec *folio_lruvec_lock(struct folio *folio)
1277 struct pglist_data *pgdat = folio_pgdat(folio);
1279 spin_lock(&pgdat->__lruvec.lru_lock);
1280 return &pgdat->__lruvec;
1283 static inline struct lruvec *folio_lruvec_lock_irq(struct folio *folio)
1285 struct pglist_data *pgdat = folio_pgdat(folio);
1287 spin_lock_irq(&pgdat->__lruvec.lru_lock);
1288 return &pgdat->__lruvec;
1291 static inline struct lruvec *folio_lruvec_lock_irqsave(struct folio *folio,
1292 unsigned long *flagsp)
1294 struct pglist_data *pgdat = folio_pgdat(folio);
1296 spin_lock_irqsave(&pgdat->__lruvec.lru_lock, *flagsp);
1297 return &pgdat->__lruvec;
1300 static inline struct mem_cgroup *
1301 mem_cgroup_iter(struct mem_cgroup *root,
1302 struct mem_cgroup *prev,
1303 struct mem_cgroup_reclaim_cookie *reclaim)
1308 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
1309 struct mem_cgroup *prev)
1313 static inline int mem_cgroup_scan_tasks(struct mem_cgroup *memcg,
1314 int (*fn)(struct task_struct *, void *), void *arg)
1319 static inline unsigned short mem_cgroup_id(struct mem_cgroup *memcg)
1324 static inline struct mem_cgroup *mem_cgroup_from_id(unsigned short id)
1327 /* XXX: This should always return root_mem_cgroup */
1331 static inline struct mem_cgroup *mem_cgroup_from_seq(struct seq_file *m)
1336 static inline struct mem_cgroup *lruvec_memcg(struct lruvec *lruvec)
1341 static inline bool mem_cgroup_online(struct mem_cgroup *memcg)
1347 unsigned long mem_cgroup_get_zone_lru_size(struct lruvec *lruvec,
1348 enum lru_list lru, int zone_idx)
1353 static inline unsigned long mem_cgroup_get_max(struct mem_cgroup *memcg)
1358 static inline unsigned long mem_cgroup_size(struct mem_cgroup *memcg)
1364 mem_cgroup_print_oom_context(struct mem_cgroup *memcg, struct task_struct *p)
1369 mem_cgroup_print_oom_meminfo(struct mem_cgroup *memcg)
1373 static inline void lock_page_memcg(struct page *page)
1377 static inline void unlock_page_memcg(struct page *page)
1381 static inline void folio_memcg_lock(struct folio *folio)
1385 static inline void folio_memcg_unlock(struct folio *folio)
1389 static inline void mem_cgroup_handle_over_high(void)
1393 static inline void mem_cgroup_enter_user_fault(void)
1397 static inline void mem_cgroup_exit_user_fault(void)
1401 static inline bool task_in_memcg_oom(struct task_struct *p)
1406 static inline bool mem_cgroup_oom_synchronize(bool wait)
1411 static inline struct mem_cgroup *mem_cgroup_get_oom_group(
1412 struct task_struct *victim, struct mem_cgroup *oom_domain)
1417 static inline void mem_cgroup_print_oom_group(struct mem_cgroup *memcg)
1421 static inline void __mod_memcg_state(struct mem_cgroup *memcg,
1427 static inline void mod_memcg_state(struct mem_cgroup *memcg,
1433 static inline void mod_memcg_page_state(struct page *page,
1438 static inline unsigned long memcg_page_state(struct mem_cgroup *memcg, int idx)
1443 static inline unsigned long lruvec_page_state(struct lruvec *lruvec,
1444 enum node_stat_item idx)
1446 return node_page_state(lruvec_pgdat(lruvec), idx);
1449 static inline unsigned long lruvec_page_state_local(struct lruvec *lruvec,
1450 enum node_stat_item idx)
1452 return node_page_state(lruvec_pgdat(lruvec), idx);
1455 static inline void mem_cgroup_flush_stats(void)
1459 static inline void mem_cgroup_flush_stats_delayed(void)
1463 static inline void __mod_memcg_lruvec_state(struct lruvec *lruvec,
1464 enum node_stat_item idx, int val)
1468 static inline void __mod_lruvec_kmem_state(void *p, enum node_stat_item idx,
1471 struct page *page = virt_to_head_page(p);
1473 __mod_node_page_state(page_pgdat(page), idx, val);
1476 static inline void mod_lruvec_kmem_state(void *p, enum node_stat_item idx,
1479 struct page *page = virt_to_head_page(p);
1481 mod_node_page_state(page_pgdat(page), idx, val);
1484 static inline void count_memcg_events(struct mem_cgroup *memcg,
1485 enum vm_event_item idx,
1486 unsigned long count)
1490 static inline void __count_memcg_events(struct mem_cgroup *memcg,
1491 enum vm_event_item idx,
1492 unsigned long count)
1496 static inline void count_memcg_page_event(struct page *page,
1502 void count_memcg_event_mm(struct mm_struct *mm, enum vm_event_item idx)
1506 static inline void split_page_memcg(struct page *head, unsigned int nr)
1511 unsigned long mem_cgroup_soft_limit_reclaim(pg_data_t *pgdat, int order,
1513 unsigned long *total_scanned)
1517 #endif /* CONFIG_MEMCG */
1519 static inline void __inc_lruvec_kmem_state(void *p, enum node_stat_item idx)
1521 __mod_lruvec_kmem_state(p, idx, 1);
1524 static inline void __dec_lruvec_kmem_state(void *p, enum node_stat_item idx)
1526 __mod_lruvec_kmem_state(p, idx, -1);
1529 static inline struct lruvec *parent_lruvec(struct lruvec *lruvec)
1531 struct mem_cgroup *memcg;
1533 memcg = lruvec_memcg(lruvec);
1536 memcg = parent_mem_cgroup(memcg);
1539 return mem_cgroup_lruvec(memcg, lruvec_pgdat(lruvec));
1542 static inline void unlock_page_lruvec(struct lruvec *lruvec)
1544 spin_unlock(&lruvec->lru_lock);
1547 static inline void unlock_page_lruvec_irq(struct lruvec *lruvec)
1549 spin_unlock_irq(&lruvec->lru_lock);
1552 static inline void unlock_page_lruvec_irqrestore(struct lruvec *lruvec,
1553 unsigned long flags)
1555 spin_unlock_irqrestore(&lruvec->lru_lock, flags);
1558 /* Test requires a stable page->memcg binding, see page_memcg() */
1559 static inline bool folio_matches_lruvec(struct folio *folio,
1560 struct lruvec *lruvec)
1562 return lruvec_pgdat(lruvec) == folio_pgdat(folio) &&
1563 lruvec_memcg(lruvec) == folio_memcg(folio);
1566 /* Don't lock again iff page's lruvec locked */
1567 static inline struct lruvec *folio_lruvec_relock_irq(struct folio *folio,
1568 struct lruvec *locked_lruvec)
1570 if (locked_lruvec) {
1571 if (folio_matches_lruvec(folio, locked_lruvec))
1572 return locked_lruvec;
1574 unlock_page_lruvec_irq(locked_lruvec);
1577 return folio_lruvec_lock_irq(folio);
1580 /* Don't lock again iff page's lruvec locked */
1581 static inline struct lruvec *folio_lruvec_relock_irqsave(struct folio *folio,
1582 struct lruvec *locked_lruvec, unsigned long *flags)
1584 if (locked_lruvec) {
1585 if (folio_matches_lruvec(folio, locked_lruvec))
1586 return locked_lruvec;
1588 unlock_page_lruvec_irqrestore(locked_lruvec, *flags);
1591 return folio_lruvec_lock_irqsave(folio, flags);
1594 #ifdef CONFIG_CGROUP_WRITEBACK
1596 struct wb_domain *mem_cgroup_wb_domain(struct bdi_writeback *wb);
1597 void mem_cgroup_wb_stats(struct bdi_writeback *wb, unsigned long *pfilepages,
1598 unsigned long *pheadroom, unsigned long *pdirty,
1599 unsigned long *pwriteback);
1601 void mem_cgroup_track_foreign_dirty_slowpath(struct folio *folio,
1602 struct bdi_writeback *wb);
1604 static inline void mem_cgroup_track_foreign_dirty(struct folio *folio,
1605 struct bdi_writeback *wb)
1607 if (mem_cgroup_disabled())
1610 if (unlikely(&folio_memcg(folio)->css != wb->memcg_css))
1611 mem_cgroup_track_foreign_dirty_slowpath(folio, wb);
1614 void mem_cgroup_flush_foreign(struct bdi_writeback *wb);
1616 #else /* CONFIG_CGROUP_WRITEBACK */
1618 static inline struct wb_domain *mem_cgroup_wb_domain(struct bdi_writeback *wb)
1623 static inline void mem_cgroup_wb_stats(struct bdi_writeback *wb,
1624 unsigned long *pfilepages,
1625 unsigned long *pheadroom,
1626 unsigned long *pdirty,
1627 unsigned long *pwriteback)
1631 static inline void mem_cgroup_track_foreign_dirty(struct folio *folio,
1632 struct bdi_writeback *wb)
1636 static inline void mem_cgroup_flush_foreign(struct bdi_writeback *wb)
1640 #endif /* CONFIG_CGROUP_WRITEBACK */
1643 bool mem_cgroup_charge_skmem(struct mem_cgroup *memcg, unsigned int nr_pages,
1645 void mem_cgroup_uncharge_skmem(struct mem_cgroup *memcg, unsigned int nr_pages);
1647 extern struct static_key_false memcg_sockets_enabled_key;
1648 #define mem_cgroup_sockets_enabled static_branch_unlikely(&memcg_sockets_enabled_key)
1649 void mem_cgroup_sk_alloc(struct sock *sk);
1650 void mem_cgroup_sk_free(struct sock *sk);
1651 static inline bool mem_cgroup_under_socket_pressure(struct mem_cgroup *memcg)
1653 if (!cgroup_subsys_on_dfl(memory_cgrp_subsys) && memcg->tcpmem_pressure)
1656 if (time_before(jiffies, READ_ONCE(memcg->socket_pressure)))
1658 } while ((memcg = parent_mem_cgroup(memcg)));
1662 int alloc_shrinker_info(struct mem_cgroup *memcg);
1663 void free_shrinker_info(struct mem_cgroup *memcg);
1664 void set_shrinker_bit(struct mem_cgroup *memcg, int nid, int shrinker_id);
1665 void reparent_shrinker_deferred(struct mem_cgroup *memcg);
1667 #define mem_cgroup_sockets_enabled 0
1668 static inline void mem_cgroup_sk_alloc(struct sock *sk) { };
1669 static inline void mem_cgroup_sk_free(struct sock *sk) { };
1670 static inline bool mem_cgroup_under_socket_pressure(struct mem_cgroup *memcg)
1675 static inline void set_shrinker_bit(struct mem_cgroup *memcg,
1676 int nid, int shrinker_id)
1681 #ifdef CONFIG_MEMCG_KMEM
1682 bool mem_cgroup_kmem_disabled(void);
1683 int __memcg_kmem_charge_page(struct page *page, gfp_t gfp, int order);
1684 void __memcg_kmem_uncharge_page(struct page *page, int order);
1686 struct obj_cgroup *get_obj_cgroup_from_current(void);
1688 int obj_cgroup_charge(struct obj_cgroup *objcg, gfp_t gfp, size_t size);
1689 void obj_cgroup_uncharge(struct obj_cgroup *objcg, size_t size);
1691 extern struct static_key_false memcg_kmem_enabled_key;
1693 static inline bool memcg_kmem_enabled(void)
1695 return static_branch_likely(&memcg_kmem_enabled_key);
1698 static inline int memcg_kmem_charge_page(struct page *page, gfp_t gfp,
1701 if (memcg_kmem_enabled())
1702 return __memcg_kmem_charge_page(page, gfp, order);
1706 static inline void memcg_kmem_uncharge_page(struct page *page, int order)
1708 if (memcg_kmem_enabled())
1709 __memcg_kmem_uncharge_page(page, order);
1713 * A helper for accessing memcg's kmem_id, used for getting
1714 * corresponding LRU lists.
1716 static inline int memcg_kmem_id(struct mem_cgroup *memcg)
1718 return memcg ? memcg->kmemcg_id : -1;
1721 struct mem_cgroup *mem_cgroup_from_obj(void *p);
1724 static inline bool mem_cgroup_kmem_disabled(void)
1729 static inline int memcg_kmem_charge_page(struct page *page, gfp_t gfp,
1735 static inline void memcg_kmem_uncharge_page(struct page *page, int order)
1739 static inline int __memcg_kmem_charge_page(struct page *page, gfp_t gfp,
1745 static inline void __memcg_kmem_uncharge_page(struct page *page, int order)
1749 static inline bool memcg_kmem_enabled(void)
1754 static inline int memcg_kmem_id(struct mem_cgroup *memcg)
1759 static inline struct mem_cgroup *mem_cgroup_from_obj(void *p)
1764 #endif /* CONFIG_MEMCG_KMEM */
1766 #endif /* _LINUX_MEMCONTROL_H */