xref: /linux-6.15/include/linux/memcontrol.h (revision 779b96d2)
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_CGROUP_MEM_RES_CTLR
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_lru_add_list(struct zone *, struct page *,
67 				       enum lru_list);
68 void mem_cgroup_lru_del_list(struct page *, enum lru_list);
69 void mem_cgroup_lru_del(struct page *);
70 struct lruvec *mem_cgroup_lru_move_lists(struct zone *, struct page *,
71 					 enum lru_list, enum lru_list);
72 
73 /* For coalescing uncharge for reducing memcg' overhead*/
74 extern void mem_cgroup_uncharge_start(void);
75 extern void mem_cgroup_uncharge_end(void);
76 
77 extern void mem_cgroup_uncharge_page(struct page *page);
78 extern void mem_cgroup_uncharge_cache_page(struct page *page);
79 
80 extern void mem_cgroup_out_of_memory(struct mem_cgroup *memcg, gfp_t gfp_mask);
81 int task_in_mem_cgroup(struct task_struct *task, const struct mem_cgroup *memcg);
82 
83 extern struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page);
84 extern struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
85 extern struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm);
86 
87 extern struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg);
88 extern struct mem_cgroup *mem_cgroup_from_cont(struct cgroup *cont);
89 
90 static inline
91 int mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *cgroup)
92 {
93 	struct mem_cgroup *memcg;
94 	rcu_read_lock();
95 	memcg = mem_cgroup_from_task(rcu_dereference((mm)->owner));
96 	rcu_read_unlock();
97 	return cgroup == memcg;
98 }
99 
100 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
101 
102 extern int
103 mem_cgroup_prepare_migration(struct page *page,
104 	struct page *newpage, struct mem_cgroup **memcgp, gfp_t gfp_mask);
105 extern void mem_cgroup_end_migration(struct mem_cgroup *memcg,
106 	struct page *oldpage, struct page *newpage, bool migration_ok);
107 
108 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
109 				   struct mem_cgroup *,
110 				   struct mem_cgroup_reclaim_cookie *);
111 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
112 
113 /*
114  * For memory reclaim.
115  */
116 int mem_cgroup_inactive_anon_is_low(struct mem_cgroup *memcg,
117 				    struct zone *zone);
118 int mem_cgroup_inactive_file_is_low(struct mem_cgroup *memcg,
119 				    struct zone *zone);
120 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
121 unsigned long mem_cgroup_zone_nr_lru_pages(struct mem_cgroup *memcg,
122 					int nid, int zid, unsigned int lrumask);
123 struct zone_reclaim_stat *mem_cgroup_get_reclaim_stat(struct mem_cgroup *memcg,
124 						      struct zone *zone);
125 struct zone_reclaim_stat*
126 mem_cgroup_get_reclaim_stat_from_page(struct page *page);
127 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
128 					struct task_struct *p);
129 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
130 					struct page *newpage);
131 
132 extern void mem_cgroup_reset_owner(struct page *page);
133 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_SWAP
134 extern int do_swap_account;
135 #endif
136 
137 static inline bool mem_cgroup_disabled(void)
138 {
139 	if (mem_cgroup_subsys.disabled)
140 		return true;
141 	return false;
142 }
143 
144 void mem_cgroup_update_page_stat(struct page *page,
145 				 enum mem_cgroup_page_stat_item idx,
146 				 int val);
147 
148 static inline void mem_cgroup_inc_page_stat(struct page *page,
149 					    enum mem_cgroup_page_stat_item idx)
150 {
151 	mem_cgroup_update_page_stat(page, idx, 1);
152 }
153 
154 static inline void mem_cgroup_dec_page_stat(struct page *page,
155 					    enum mem_cgroup_page_stat_item idx)
156 {
157 	mem_cgroup_update_page_stat(page, idx, -1);
158 }
159 
160 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
161 						gfp_t gfp_mask,
162 						unsigned long *total_scanned);
163 u64 mem_cgroup_get_limit(struct mem_cgroup *memcg);
164 
165 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
166 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
167 void mem_cgroup_split_huge_fixup(struct page *head);
168 #endif
169 
170 #ifdef CONFIG_DEBUG_VM
171 bool mem_cgroup_bad_page_check(struct page *page);
172 void mem_cgroup_print_bad_page(struct page *page);
173 #endif
174 #else /* CONFIG_CGROUP_MEM_RES_CTLR */
175 struct mem_cgroup;
176 
177 static inline int mem_cgroup_newpage_charge(struct page *page,
178 					struct mm_struct *mm, gfp_t gfp_mask)
179 {
180 	return 0;
181 }
182 
183 static inline int mem_cgroup_cache_charge(struct page *page,
184 					struct mm_struct *mm, gfp_t gfp_mask)
185 {
186 	return 0;
187 }
188 
189 static inline int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
190 		struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
191 {
192 	return 0;
193 }
194 
195 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
196 					  struct mem_cgroup *memcg)
197 {
198 }
199 
200 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
201 {
202 }
203 
204 static inline void mem_cgroup_uncharge_start(void)
205 {
206 }
207 
208 static inline void mem_cgroup_uncharge_end(void)
209 {
210 }
211 
212 static inline void mem_cgroup_uncharge_page(struct page *page)
213 {
214 }
215 
216 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
217 {
218 }
219 
220 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
221 						    struct mem_cgroup *memcg)
222 {
223 	return &zone->lruvec;
224 }
225 
226 static inline struct lruvec *mem_cgroup_lru_add_list(struct zone *zone,
227 						     struct page *page,
228 						     enum lru_list lru)
229 {
230 	return &zone->lruvec;
231 }
232 
233 static inline void mem_cgroup_lru_del_list(struct page *page, enum lru_list lru)
234 {
235 }
236 
237 static inline void mem_cgroup_lru_del(struct page *page)
238 {
239 }
240 
241 static inline struct lruvec *mem_cgroup_lru_move_lists(struct zone *zone,
242 						       struct page *page,
243 						       enum lru_list from,
244 						       enum lru_list to)
245 {
246 	return &zone->lruvec;
247 }
248 
249 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
250 {
251 	return NULL;
252 }
253 
254 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
255 {
256 	return NULL;
257 }
258 
259 static inline int mm_match_cgroup(struct mm_struct *mm,
260 		struct mem_cgroup *memcg)
261 {
262 	return 1;
263 }
264 
265 static inline int task_in_mem_cgroup(struct task_struct *task,
266 				     const struct mem_cgroup *memcg)
267 {
268 	return 1;
269 }
270 
271 static inline struct cgroup_subsys_state
272 		*mem_cgroup_css(struct mem_cgroup *memcg)
273 {
274 	return NULL;
275 }
276 
277 static inline int
278 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
279 	struct mem_cgroup **memcgp, gfp_t gfp_mask)
280 {
281 	return 0;
282 }
283 
284 static inline void mem_cgroup_end_migration(struct mem_cgroup *memcg,
285 		struct page *oldpage, struct page *newpage, bool migration_ok)
286 {
287 }
288 
289 static inline struct mem_cgroup *
290 mem_cgroup_iter(struct mem_cgroup *root,
291 		struct mem_cgroup *prev,
292 		struct mem_cgroup_reclaim_cookie *reclaim)
293 {
294 	return NULL;
295 }
296 
297 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
298 					 struct mem_cgroup *prev)
299 {
300 }
301 
302 static inline int mem_cgroup_get_reclaim_priority(struct mem_cgroup *memcg)
303 {
304 	return 0;
305 }
306 
307 static inline void mem_cgroup_note_reclaim_priority(struct mem_cgroup *memcg,
308 						int priority)
309 {
310 }
311 
312 static inline void mem_cgroup_record_reclaim_priority(struct mem_cgroup *memcg,
313 						int priority)
314 {
315 }
316 
317 static inline bool mem_cgroup_disabled(void)
318 {
319 	return true;
320 }
321 
322 static inline int
323 mem_cgroup_inactive_anon_is_low(struct mem_cgroup *memcg, struct zone *zone)
324 {
325 	return 1;
326 }
327 
328 static inline int
329 mem_cgroup_inactive_file_is_low(struct mem_cgroup *memcg, struct zone *zone)
330 {
331 	return 1;
332 }
333 
334 static inline unsigned long
335 mem_cgroup_zone_nr_lru_pages(struct mem_cgroup *memcg, int nid, int zid,
336 				unsigned int lru_mask)
337 {
338 	return 0;
339 }
340 
341 
342 static inline struct zone_reclaim_stat*
343 mem_cgroup_get_reclaim_stat(struct mem_cgroup *memcg, struct zone *zone)
344 {
345 	return NULL;
346 }
347 
348 static inline struct zone_reclaim_stat*
349 mem_cgroup_get_reclaim_stat_from_page(struct page *page)
350 {
351 	return NULL;
352 }
353 
354 static inline void
355 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
356 {
357 }
358 
359 static inline void mem_cgroup_inc_page_stat(struct page *page,
360 					    enum mem_cgroup_page_stat_item idx)
361 {
362 }
363 
364 static inline void mem_cgroup_dec_page_stat(struct page *page,
365 					    enum mem_cgroup_page_stat_item idx)
366 {
367 }
368 
369 static inline
370 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
371 					    gfp_t gfp_mask,
372 					    unsigned long *total_scanned)
373 {
374 	return 0;
375 }
376 
377 static inline
378 u64 mem_cgroup_get_limit(struct mem_cgroup *memcg)
379 {
380 	return 0;
381 }
382 
383 static inline void mem_cgroup_split_huge_fixup(struct page *head)
384 {
385 }
386 
387 static inline
388 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
389 {
390 }
391 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
392 				struct page *newpage)
393 {
394 }
395 
396 static inline void mem_cgroup_reset_owner(struct page *page)
397 {
398 }
399 #endif /* CONFIG_CGROUP_MEM_CONT */
400 
401 #if !defined(CONFIG_CGROUP_MEM_RES_CTLR) || !defined(CONFIG_DEBUG_VM)
402 static inline bool
403 mem_cgroup_bad_page_check(struct page *page)
404 {
405 	return false;
406 }
407 
408 static inline void
409 mem_cgroup_print_bad_page(struct page *page)
410 {
411 }
412 #endif
413 
414 enum {
415 	UNDER_LIMIT,
416 	SOFT_LIMIT,
417 	OVER_LIMIT,
418 };
419 
420 struct sock;
421 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
422 void sock_update_memcg(struct sock *sk);
423 void sock_release_memcg(struct sock *sk);
424 #else
425 static inline void sock_update_memcg(struct sock *sk)
426 {
427 }
428 static inline void sock_release_memcg(struct sock *sk)
429 {
430 }
431 #endif /* CONFIG_CGROUP_MEM_RES_CTLR_KMEM */
432 #endif /* _LINUX_MEMCONTROL_H */
433 
434