xref: /linux-6.15/include/linux/memcontrol.h (revision 261a9af6) 
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 extern unsigned long mem_cgroup_isolate_pages(unsigned long nr_to_scan,
36 					struct list_head *dst,
37 					unsigned long *scanned, int order,
38 					int mode, struct zone *z,
39 					struct mem_cgroup *mem_cont,
40 					int active, int file);
41 
42 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
43 /*
44  * All "charge" functions with gfp_mask should use GFP_KERNEL or
45  * (gfp_mask & GFP_RECLAIM_MASK). In current implementatin, memcg doesn't
46  * alloc memory but reclaims memory from all available zones. So, "where I want
47  * memory from" bits of gfp_mask has no meaning. So any bits of that field is
48  * available but adding a rule is better. charge functions' gfp_mask should
49  * be set to GFP_KERNEL or gfp_mask & GFP_RECLAIM_MASK for avoiding ambiguous
50  * codes.
51  * (Of course, if memcg does memory allocation in future, GFP_KERNEL is sane.)
52  */
53 
54 extern int mem_cgroup_newpage_charge(struct page *page, struct mm_struct *mm,
55 				gfp_t gfp_mask);
56 /* for swap handling */
57 extern int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
58 		struct page *page, gfp_t mask, struct mem_cgroup **ptr);
59 extern void mem_cgroup_commit_charge_swapin(struct page *page,
60 					struct mem_cgroup *ptr);
61 extern void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *ptr);
62 
63 extern int mem_cgroup_cache_charge(struct page *page, struct mm_struct *mm,
64 					gfp_t gfp_mask);
65 extern void mem_cgroup_add_lru_list(struct page *page, enum lru_list lru);
66 extern void mem_cgroup_del_lru_list(struct page *page, enum lru_list lru);
67 extern void mem_cgroup_rotate_reclaimable_page(struct page *page);
68 extern void mem_cgroup_rotate_lru_list(struct page *page, enum lru_list lru);
69 extern void mem_cgroup_del_lru(struct page *page);
70 extern void mem_cgroup_move_lists(struct page *page,
71 				  enum lru_list from, enum lru_list to);
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 extern int mem_cgroup_shmem_charge_fallback(struct page *page,
80 			struct mm_struct *mm, gfp_t gfp_mask);
81 
82 extern void mem_cgroup_out_of_memory(struct mem_cgroup *mem, gfp_t gfp_mask);
83 int task_in_mem_cgroup(struct task_struct *task, const struct mem_cgroup *mem);
84 
85 extern struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page);
86 extern struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
87 
88 static inline
89 int mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *cgroup)
90 {
91 	struct mem_cgroup *mem;
92 	rcu_read_lock();
93 	mem = mem_cgroup_from_task(rcu_dereference((mm)->owner));
94 	rcu_read_unlock();
95 	return cgroup == mem;
96 }
97 
98 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *mem);
99 
100 extern int
101 mem_cgroup_prepare_migration(struct page *page,
102 	struct page *newpage, struct mem_cgroup **ptr, gfp_t gfp_mask);
103 extern void mem_cgroup_end_migration(struct mem_cgroup *mem,
104 	struct page *oldpage, struct page *newpage, bool migration_ok);
105 
106 /*
107  * For memory reclaim.
108  */
109 int mem_cgroup_inactive_anon_is_low(struct mem_cgroup *memcg);
110 int mem_cgroup_inactive_file_is_low(struct mem_cgroup *memcg);
111 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
112 unsigned long mem_cgroup_zone_nr_lru_pages(struct mem_cgroup *memcg,
113 						struct zone *zone,
114 						enum lru_list lru);
115 struct zone_reclaim_stat *mem_cgroup_get_reclaim_stat(struct mem_cgroup *memcg,
116 						      struct zone *zone);
117 struct zone_reclaim_stat*
118 mem_cgroup_get_reclaim_stat_from_page(struct page *page);
119 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
120 					struct task_struct *p);
121 
122 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_SWAP
123 extern int do_swap_account;
124 #endif
125 
126 static inline bool mem_cgroup_disabled(void)
127 {
128 	if (mem_cgroup_subsys.disabled)
129 		return true;
130 	return false;
131 }
132 
133 void mem_cgroup_update_page_stat(struct page *page,
134 				 enum mem_cgroup_page_stat_item idx,
135 				 int val);
136 
137 static inline void mem_cgroup_inc_page_stat(struct page *page,
138 					    enum mem_cgroup_page_stat_item idx)
139 {
140 	mem_cgroup_update_page_stat(page, idx, 1);
141 }
142 
143 static inline void mem_cgroup_dec_page_stat(struct page *page,
144 					    enum mem_cgroup_page_stat_item idx)
145 {
146 	mem_cgroup_update_page_stat(page, idx, -1);
147 }
148 
149 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
150 						gfp_t gfp_mask,
151 						unsigned long *total_scanned);
152 u64 mem_cgroup_get_limit(struct mem_cgroup *mem);
153 
154 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
155 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
156 void mem_cgroup_split_huge_fixup(struct page *head, struct page *tail);
157 #endif
158 
159 #ifdef CONFIG_DEBUG_VM
160 bool mem_cgroup_bad_page_check(struct page *page);
161 void mem_cgroup_print_bad_page(struct page *page);
162 #endif
163 #else /* CONFIG_CGROUP_MEM_RES_CTLR */
164 struct mem_cgroup;
165 
166 static inline int mem_cgroup_newpage_charge(struct page *page,
167 					struct mm_struct *mm, gfp_t gfp_mask)
168 {
169 	return 0;
170 }
171 
172 static inline int mem_cgroup_cache_charge(struct page *page,
173 					struct mm_struct *mm, gfp_t gfp_mask)
174 {
175 	return 0;
176 }
177 
178 static inline int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
179 		struct page *page, gfp_t gfp_mask, struct mem_cgroup **ptr)
180 {
181 	return 0;
182 }
183 
184 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
185 					  struct mem_cgroup *ptr)
186 {
187 }
188 
189 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *ptr)
190 {
191 }
192 
193 static inline void mem_cgroup_uncharge_start(void)
194 {
195 }
196 
197 static inline void mem_cgroup_uncharge_end(void)
198 {
199 }
200 
201 static inline void mem_cgroup_uncharge_page(struct page *page)
202 {
203 }
204 
205 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
206 {
207 }
208 
209 static inline int mem_cgroup_shmem_charge_fallback(struct page *page,
210 			struct mm_struct *mm, gfp_t gfp_mask)
211 {
212 	return 0;
213 }
214 
215 static inline void mem_cgroup_add_lru_list(struct page *page, int lru)
216 {
217 }
218 
219 static inline void mem_cgroup_del_lru_list(struct page *page, int lru)
220 {
221 	return ;
222 }
223 
224 static inline void mem_cgroup_rotate_reclaimable_page(struct page *page)
225 {
226 	return ;
227 }
228 
229 static inline void mem_cgroup_rotate_lru_list(struct page *page, int lru)
230 {
231 	return ;
232 }
233 
234 static inline void mem_cgroup_del_lru(struct page *page)
235 {
236 	return ;
237 }
238 
239 static inline void
240 mem_cgroup_move_lists(struct page *page, enum lru_list from, enum lru_list to)
241 {
242 }
243 
244 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
245 {
246 	return NULL;
247 }
248 
249 static inline int mm_match_cgroup(struct mm_struct *mm, struct mem_cgroup *mem)
250 {
251 	return 1;
252 }
253 
254 static inline int task_in_mem_cgroup(struct task_struct *task,
255 				     const struct mem_cgroup *mem)
256 {
257 	return 1;
258 }
259 
260 static inline struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *mem)
261 {
262 	return NULL;
263 }
264 
265 static inline int
266 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
267 	struct mem_cgroup **ptr, gfp_t gfp_mask)
268 {
269 	return 0;
270 }
271 
272 static inline void mem_cgroup_end_migration(struct mem_cgroup *mem,
273 		struct page *oldpage, struct page *newpage, bool migration_ok)
274 {
275 }
276 
277 static inline int mem_cgroup_get_reclaim_priority(struct mem_cgroup *mem)
278 {
279 	return 0;
280 }
281 
282 static inline void mem_cgroup_note_reclaim_priority(struct mem_cgroup *mem,
283 						int priority)
284 {
285 }
286 
287 static inline void mem_cgroup_record_reclaim_priority(struct mem_cgroup *mem,
288 						int priority)
289 {
290 }
291 
292 static inline bool mem_cgroup_disabled(void)
293 {
294 	return true;
295 }
296 
297 static inline int
298 mem_cgroup_inactive_anon_is_low(struct mem_cgroup *memcg)
299 {
300 	return 1;
301 }
302 
303 static inline int
304 mem_cgroup_inactive_file_is_low(struct mem_cgroup *memcg)
305 {
306 	return 1;
307 }
308 
309 static inline unsigned long
310 mem_cgroup_zone_nr_lru_pages(struct mem_cgroup *memcg, struct zone *zone,
311 			     enum lru_list lru)
312 {
313 	return 0;
314 }
315 
316 
317 static inline struct zone_reclaim_stat*
318 mem_cgroup_get_reclaim_stat(struct mem_cgroup *memcg, struct zone *zone)
319 {
320 	return NULL;
321 }
322 
323 static inline struct zone_reclaim_stat*
324 mem_cgroup_get_reclaim_stat_from_page(struct page *page)
325 {
326 	return NULL;
327 }
328 
329 static inline void
330 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
331 {
332 }
333 
334 static inline void mem_cgroup_inc_page_stat(struct page *page,
335 					    enum mem_cgroup_page_stat_item idx)
336 {
337 }
338 
339 static inline void mem_cgroup_dec_page_stat(struct page *page,
340 					    enum mem_cgroup_page_stat_item idx)
341 {
342 }
343 
344 static inline
345 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
346 					    gfp_t gfp_mask,
347 					    unsigned long *total_scanned)
348 {
349 	return 0;
350 }
351 
352 static inline
353 u64 mem_cgroup_get_limit(struct mem_cgroup *mem)
354 {
355 	return 0;
356 }
357 
358 static inline void mem_cgroup_split_huge_fixup(struct page *head,
359 						struct page *tail)
360 {
361 }
362 
363 static inline
364 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
365 {
366 }
367 #endif /* CONFIG_CGROUP_MEM_CONT */
368 
369 #if !defined(CONFIG_CGROUP_MEM_RES_CTLR) || !defined(CONFIG_DEBUG_VM)
370 static inline bool
371 mem_cgroup_bad_page_check(struct page *page)
372 {
373 	return false;
374 }
375 
376 static inline void
377 mem_cgroup_print_bad_page(struct page *page)
378 {
379 }
380 #endif
381 
382 #endif /* _LINUX_MEMCONTROL_H */
383 
384