xref: /linux-6.15/include/linux/memcontrol.h (revision 63d23367)
1 /* memcontrol.h - Memory Controller
2  *
3  * Copyright IBM Corporation, 2007
4  * Author Balbir Singh <[email protected]>
5  *
6  * Copyright 2007 OpenVZ SWsoft Inc
7  * Author: Pavel Emelianov <[email protected]>
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 
25 struct mem_cgroup;
26 struct page_cgroup;
27 struct page;
28 struct mm_struct;
29 
30 /* Stats that can be updated by kernel. */
31 enum mem_cgroup_page_stat_item {
32 	MEMCG_NR_FILE_MAPPED, /* # of pages charged as file rss */
33 };
34 
35 struct mem_cgroup_reclaim_cookie {
36 	struct zone *zone;
37 	int priority;
38 	unsigned int generation;
39 };
40 
41 #ifdef CONFIG_MEMCG
42 /*
43  * All "charge" functions with gfp_mask should use GFP_KERNEL or
44  * (gfp_mask & GFP_RECLAIM_MASK). In current implementatin, memcg doesn't
45  * alloc memory but reclaims memory from all available zones. So, "where I want
46  * memory from" bits of gfp_mask has no meaning. So any bits of that field is
47  * available but adding a rule is better. charge functions' gfp_mask should
48  * be set to GFP_KERNEL or gfp_mask & GFP_RECLAIM_MASK for avoiding ambiguous
49  * codes.
50  * (Of course, if memcg does memory allocation in future, GFP_KERNEL is sane.)
51  */
52 
53 extern int mem_cgroup_newpage_charge(struct page *page, struct mm_struct *mm,
54 				gfp_t gfp_mask);
55 /* for swap handling */
56 extern int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
57 		struct page *page, gfp_t mask, struct mem_cgroup **memcgp);
58 extern void mem_cgroup_commit_charge_swapin(struct page *page,
59 					struct mem_cgroup *memcg);
60 extern void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg);
61 
62 extern int mem_cgroup_cache_charge(struct page *page, struct mm_struct *mm,
63 					gfp_t gfp_mask);
64 
65 struct lruvec *mem_cgroup_zone_lruvec(struct zone *, struct mem_cgroup *);
66 struct lruvec *mem_cgroup_page_lruvec(struct page *, struct zone *);
67 
68 /* For coalescing uncharge for reducing memcg' overhead*/
69 extern void mem_cgroup_uncharge_start(void);
70 extern void mem_cgroup_uncharge_end(void);
71 
72 extern void mem_cgroup_uncharge_page(struct page *page);
73 extern void mem_cgroup_uncharge_cache_page(struct page *page);
74 
75 bool __mem_cgroup_same_or_subtree(const struct mem_cgroup *root_memcg,
76 				  struct mem_cgroup *memcg);
77 int task_in_mem_cgroup(struct task_struct *task, const struct mem_cgroup *memcg);
78 
79 extern struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page);
80 extern struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
81 extern struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm);
82 
83 extern struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg);
84 extern struct mem_cgroup *mem_cgroup_from_cont(struct cgroup *cont);
85 
86 static inline
87 bool mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *memcg)
88 {
89 	struct mem_cgroup *task_memcg;
90 	bool match;
91 
92 	rcu_read_lock();
93 	task_memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
94 	match = __mem_cgroup_same_or_subtree(memcg, task_memcg);
95 	rcu_read_unlock();
96 	return match;
97 }
98 
99 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
100 
101 extern void
102 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
103 			     struct mem_cgroup **memcgp);
104 extern void mem_cgroup_end_migration(struct mem_cgroup *memcg,
105 	struct page *oldpage, struct page *newpage, bool migration_ok);
106 
107 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
108 				   struct mem_cgroup *,
109 				   struct mem_cgroup_reclaim_cookie *);
110 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
111 
112 /*
113  * For memory reclaim.
114  */
115 int mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec);
116 int mem_cgroup_inactive_file_is_low(struct lruvec *lruvec);
117 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
118 unsigned long mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list);
119 void mem_cgroup_update_lru_size(struct lruvec *, enum lru_list, int);
120 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
121 					struct task_struct *p);
122 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
123 					struct page *newpage);
124 
125 #ifdef CONFIG_MEMCG_SWAP
126 extern int do_swap_account;
127 #endif
128 
129 static inline bool mem_cgroup_disabled(void)
130 {
131 	if (mem_cgroup_subsys.disabled)
132 		return true;
133 	return false;
134 }
135 
136 void __mem_cgroup_begin_update_page_stat(struct page *page, bool *locked,
137 					 unsigned long *flags);
138 
139 extern atomic_t memcg_moving;
140 
141 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
142 					bool *locked, unsigned long *flags)
143 {
144 	if (mem_cgroup_disabled())
145 		return;
146 	rcu_read_lock();
147 	*locked = false;
148 	if (atomic_read(&memcg_moving))
149 		__mem_cgroup_begin_update_page_stat(page, locked, flags);
150 }
151 
152 void __mem_cgroup_end_update_page_stat(struct page *page,
153 				unsigned long *flags);
154 static inline void mem_cgroup_end_update_page_stat(struct page *page,
155 					bool *locked, unsigned long *flags)
156 {
157 	if (mem_cgroup_disabled())
158 		return;
159 	if (*locked)
160 		__mem_cgroup_end_update_page_stat(page, flags);
161 	rcu_read_unlock();
162 }
163 
164 void mem_cgroup_update_page_stat(struct page *page,
165 				 enum mem_cgroup_page_stat_item idx,
166 				 int val);
167 
168 static inline void mem_cgroup_inc_page_stat(struct page *page,
169 					    enum mem_cgroup_page_stat_item idx)
170 {
171 	mem_cgroup_update_page_stat(page, idx, 1);
172 }
173 
174 static inline void mem_cgroup_dec_page_stat(struct page *page,
175 					    enum mem_cgroup_page_stat_item idx)
176 {
177 	mem_cgroup_update_page_stat(page, idx, -1);
178 }
179 
180 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
181 						gfp_t gfp_mask,
182 						unsigned long *total_scanned);
183 
184 void __mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
185 static inline void mem_cgroup_count_vm_event(struct mm_struct *mm,
186 					     enum vm_event_item idx)
187 {
188 	if (mem_cgroup_disabled())
189 		return;
190 	__mem_cgroup_count_vm_event(mm, idx);
191 }
192 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
193 void mem_cgroup_split_huge_fixup(struct page *head);
194 #endif
195 
196 #ifdef CONFIG_DEBUG_VM
197 bool mem_cgroup_bad_page_check(struct page *page);
198 void mem_cgroup_print_bad_page(struct page *page);
199 #endif
200 #else /* CONFIG_MEMCG */
201 struct mem_cgroup;
202 
203 static inline int mem_cgroup_newpage_charge(struct page *page,
204 					struct mm_struct *mm, gfp_t gfp_mask)
205 {
206 	return 0;
207 }
208 
209 static inline int mem_cgroup_cache_charge(struct page *page,
210 					struct mm_struct *mm, gfp_t gfp_mask)
211 {
212 	return 0;
213 }
214 
215 static inline int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
216 		struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
217 {
218 	return 0;
219 }
220 
221 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
222 					  struct mem_cgroup *memcg)
223 {
224 }
225 
226 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
227 {
228 }
229 
230 static inline void mem_cgroup_uncharge_start(void)
231 {
232 }
233 
234 static inline void mem_cgroup_uncharge_end(void)
235 {
236 }
237 
238 static inline void mem_cgroup_uncharge_page(struct page *page)
239 {
240 }
241 
242 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
243 {
244 }
245 
246 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
247 						    struct mem_cgroup *memcg)
248 {
249 	return &zone->lruvec;
250 }
251 
252 static inline struct lruvec *mem_cgroup_page_lruvec(struct page *page,
253 						    struct zone *zone)
254 {
255 	return &zone->lruvec;
256 }
257 
258 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
259 {
260 	return NULL;
261 }
262 
263 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
264 {
265 	return NULL;
266 }
267 
268 static inline bool mm_match_cgroup(struct mm_struct *mm,
269 		struct mem_cgroup *memcg)
270 {
271 	return true;
272 }
273 
274 static inline int task_in_mem_cgroup(struct task_struct *task,
275 				     const struct mem_cgroup *memcg)
276 {
277 	return 1;
278 }
279 
280 static inline struct cgroup_subsys_state
281 		*mem_cgroup_css(struct mem_cgroup *memcg)
282 {
283 	return NULL;
284 }
285 
286 static inline void
287 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
288 			     struct mem_cgroup **memcgp)
289 {
290 }
291 
292 static inline void mem_cgroup_end_migration(struct mem_cgroup *memcg,
293 		struct page *oldpage, struct page *newpage, bool migration_ok)
294 {
295 }
296 
297 static inline struct mem_cgroup *
298 mem_cgroup_iter(struct mem_cgroup *root,
299 		struct mem_cgroup *prev,
300 		struct mem_cgroup_reclaim_cookie *reclaim)
301 {
302 	return NULL;
303 }
304 
305 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
306 					 struct mem_cgroup *prev)
307 {
308 }
309 
310 static inline bool mem_cgroup_disabled(void)
311 {
312 	return true;
313 }
314 
315 static inline int
316 mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec)
317 {
318 	return 1;
319 }
320 
321 static inline int
322 mem_cgroup_inactive_file_is_low(struct lruvec *lruvec)
323 {
324 	return 1;
325 }
326 
327 static inline unsigned long
328 mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list lru)
329 {
330 	return 0;
331 }
332 
333 static inline void
334 mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
335 			      int increment)
336 {
337 }
338 
339 static inline void
340 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
341 {
342 }
343 
344 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
345 					bool *locked, unsigned long *flags)
346 {
347 }
348 
349 static inline void mem_cgroup_end_update_page_stat(struct page *page,
350 					bool *locked, unsigned long *flags)
351 {
352 }
353 
354 static inline void mem_cgroup_inc_page_stat(struct page *page,
355 					    enum mem_cgroup_page_stat_item idx)
356 {
357 }
358 
359 static inline void mem_cgroup_dec_page_stat(struct page *page,
360 					    enum mem_cgroup_page_stat_item idx)
361 {
362 }
363 
364 static inline
365 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
366 					    gfp_t gfp_mask,
367 					    unsigned long *total_scanned)
368 {
369 	return 0;
370 }
371 
372 static inline void mem_cgroup_split_huge_fixup(struct page *head)
373 {
374 }
375 
376 static inline
377 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
378 {
379 }
380 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
381 				struct page *newpage)
382 {
383 }
384 #endif /* CONFIG_MEMCG */
385 
386 #if !defined(CONFIG_MEMCG) || !defined(CONFIG_DEBUG_VM)
387 static inline bool
388 mem_cgroup_bad_page_check(struct page *page)
389 {
390 	return false;
391 }
392 
393 static inline void
394 mem_cgroup_print_bad_page(struct page *page)
395 {
396 }
397 #endif
398 
399 enum {
400 	UNDER_LIMIT,
401 	SOFT_LIMIT,
402 	OVER_LIMIT,
403 };
404 
405 struct sock;
406 #if defined(CONFIG_INET) && defined(CONFIG_MEMCG_KMEM)
407 void sock_update_memcg(struct sock *sk);
408 void sock_release_memcg(struct sock *sk);
409 #else
410 static inline void sock_update_memcg(struct sock *sk)
411 {
412 }
413 static inline void sock_release_memcg(struct sock *sk)
414 {
415 }
416 #endif /* CONFIG_INET && CONFIG_MEMCG_KMEM */
417 #endif /* _LINUX_MEMCONTROL_H */
418 
419