]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - include/linux/memcontrol.h
memcg: kmem controller infrastructure
[~shefty/rdma-dev.git] / include / linux / memcontrol.h
1 /* memcontrol.h - Memory Controller
2  *
3  * Copyright IBM Corporation, 2007
4  * Author Balbir Singh <balbir@linux.vnet.ibm.com>
5  *
6  * Copyright 2007 OpenVZ SWsoft Inc
7  * Author: Pavel Emelianov <xemul@openvz.org>
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 #include <linux/hardirq.h>
25
26 struct mem_cgroup;
27 struct page_cgroup;
28 struct page;
29 struct mm_struct;
30
31 /* Stats that can be updated by kernel. */
32 enum mem_cgroup_page_stat_item {
33         MEMCG_NR_FILE_MAPPED, /* # of pages charged as file rss */
34 };
35
36 struct mem_cgroup_reclaim_cookie {
37         struct zone *zone;
38         int priority;
39         unsigned int generation;
40 };
41
42 #ifdef CONFIG_MEMCG
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 **memcgp);
59 extern void mem_cgroup_commit_charge_swapin(struct page *page,
60                                         struct mem_cgroup *memcg);
61 extern void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg);
62
63 extern int mem_cgroup_cache_charge(struct page *page, struct mm_struct *mm,
64                                         gfp_t gfp_mask);
65
66 struct lruvec *mem_cgroup_zone_lruvec(struct zone *, struct mem_cgroup *);
67 struct lruvec *mem_cgroup_page_lruvec(struct page *, struct zone *);
68
69 /* For coalescing uncharge for reducing memcg' overhead*/
70 extern void mem_cgroup_uncharge_start(void);
71 extern void mem_cgroup_uncharge_end(void);
72
73 extern void mem_cgroup_uncharge_page(struct page *page);
74 extern void mem_cgroup_uncharge_cache_page(struct page *page);
75
76 bool __mem_cgroup_same_or_subtree(const struct mem_cgroup *root_memcg,
77                                   struct mem_cgroup *memcg);
78 int task_in_mem_cgroup(struct task_struct *task, const struct mem_cgroup *memcg);
79
80 extern struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page);
81 extern struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
82 extern struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm);
83
84 extern struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg);
85 extern struct mem_cgroup *mem_cgroup_from_cont(struct cgroup *cont);
86
87 static inline
88 bool mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *memcg)
89 {
90         struct mem_cgroup *task_memcg;
91         bool match;
92
93         rcu_read_lock();
94         task_memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
95         match = __mem_cgroup_same_or_subtree(memcg, task_memcg);
96         rcu_read_unlock();
97         return match;
98 }
99
100 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
101
102 extern void
103 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
104                              struct mem_cgroup **memcgp);
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 lruvec *lruvec);
117 int mem_cgroup_inactive_file_is_low(struct lruvec *lruvec);
118 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
119 unsigned long mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list);
120 void mem_cgroup_update_lru_size(struct lruvec *, enum lru_list, int);
121 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
122                                         struct task_struct *p);
123 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
124                                         struct page *newpage);
125
126 #ifdef CONFIG_MEMCG_SWAP
127 extern int do_swap_account;
128 #endif
129
130 static inline bool mem_cgroup_disabled(void)
131 {
132         if (mem_cgroup_subsys.disabled)
133                 return true;
134         return false;
135 }
136
137 void __mem_cgroup_begin_update_page_stat(struct page *page, bool *locked,
138                                          unsigned long *flags);
139
140 extern atomic_t memcg_moving;
141
142 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
143                                         bool *locked, unsigned long *flags)
144 {
145         if (mem_cgroup_disabled())
146                 return;
147         rcu_read_lock();
148         *locked = false;
149         if (atomic_read(&memcg_moving))
150                 __mem_cgroup_begin_update_page_stat(page, locked, flags);
151 }
152
153 void __mem_cgroup_end_update_page_stat(struct page *page,
154                                 unsigned long *flags);
155 static inline void mem_cgroup_end_update_page_stat(struct page *page,
156                                         bool *locked, unsigned long *flags)
157 {
158         if (mem_cgroup_disabled())
159                 return;
160         if (*locked)
161                 __mem_cgroup_end_update_page_stat(page, flags);
162         rcu_read_unlock();
163 }
164
165 void mem_cgroup_update_page_stat(struct page *page,
166                                  enum mem_cgroup_page_stat_item idx,
167                                  int val);
168
169 static inline void mem_cgroup_inc_page_stat(struct page *page,
170                                             enum mem_cgroup_page_stat_item idx)
171 {
172         mem_cgroup_update_page_stat(page, idx, 1);
173 }
174
175 static inline void mem_cgroup_dec_page_stat(struct page *page,
176                                             enum mem_cgroup_page_stat_item idx)
177 {
178         mem_cgroup_update_page_stat(page, idx, -1);
179 }
180
181 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
182                                                 gfp_t gfp_mask,
183                                                 unsigned long *total_scanned);
184
185 void __mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
186 static inline void mem_cgroup_count_vm_event(struct mm_struct *mm,
187                                              enum vm_event_item idx)
188 {
189         if (mem_cgroup_disabled())
190                 return;
191         __mem_cgroup_count_vm_event(mm, idx);
192 }
193 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
194 void mem_cgroup_split_huge_fixup(struct page *head);
195 #endif
196
197 #ifdef CONFIG_DEBUG_VM
198 bool mem_cgroup_bad_page_check(struct page *page);
199 void mem_cgroup_print_bad_page(struct page *page);
200 #endif
201 #else /* CONFIG_MEMCG */
202 struct mem_cgroup;
203
204 static inline int mem_cgroup_newpage_charge(struct page *page,
205                                         struct mm_struct *mm, gfp_t gfp_mask)
206 {
207         return 0;
208 }
209
210 static inline int mem_cgroup_cache_charge(struct page *page,
211                                         struct mm_struct *mm, gfp_t gfp_mask)
212 {
213         return 0;
214 }
215
216 static inline int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
217                 struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
218 {
219         return 0;
220 }
221
222 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
223                                           struct mem_cgroup *memcg)
224 {
225 }
226
227 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
228 {
229 }
230
231 static inline void mem_cgroup_uncharge_start(void)
232 {
233 }
234
235 static inline void mem_cgroup_uncharge_end(void)
236 {
237 }
238
239 static inline void mem_cgroup_uncharge_page(struct page *page)
240 {
241 }
242
243 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
244 {
245 }
246
247 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
248                                                     struct mem_cgroup *memcg)
249 {
250         return &zone->lruvec;
251 }
252
253 static inline struct lruvec *mem_cgroup_page_lruvec(struct page *page,
254                                                     struct zone *zone)
255 {
256         return &zone->lruvec;
257 }
258
259 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
260 {
261         return NULL;
262 }
263
264 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
265 {
266         return NULL;
267 }
268
269 static inline bool mm_match_cgroup(struct mm_struct *mm,
270                 struct mem_cgroup *memcg)
271 {
272         return true;
273 }
274
275 static inline int task_in_mem_cgroup(struct task_struct *task,
276                                      const struct mem_cgroup *memcg)
277 {
278         return 1;
279 }
280
281 static inline struct cgroup_subsys_state
282                 *mem_cgroup_css(struct mem_cgroup *memcg)
283 {
284         return NULL;
285 }
286
287 static inline void
288 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
289                              struct mem_cgroup **memcgp)
290 {
291 }
292
293 static inline void mem_cgroup_end_migration(struct mem_cgroup *memcg,
294                 struct page *oldpage, struct page *newpage, bool migration_ok)
295 {
296 }
297
298 static inline struct mem_cgroup *
299 mem_cgroup_iter(struct mem_cgroup *root,
300                 struct mem_cgroup *prev,
301                 struct mem_cgroup_reclaim_cookie *reclaim)
302 {
303         return NULL;
304 }
305
306 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
307                                          struct mem_cgroup *prev)
308 {
309 }
310
311 static inline bool mem_cgroup_disabled(void)
312 {
313         return true;
314 }
315
316 static inline int
317 mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec)
318 {
319         return 1;
320 }
321
322 static inline int
323 mem_cgroup_inactive_file_is_low(struct lruvec *lruvec)
324 {
325         return 1;
326 }
327
328 static inline unsigned long
329 mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list lru)
330 {
331         return 0;
332 }
333
334 static inline void
335 mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
336                               int increment)
337 {
338 }
339
340 static inline void
341 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
342 {
343 }
344
345 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
346                                         bool *locked, unsigned long *flags)
347 {
348 }
349
350 static inline void mem_cgroup_end_update_page_stat(struct page *page,
351                                         bool *locked, unsigned long *flags)
352 {
353 }
354
355 static inline void mem_cgroup_inc_page_stat(struct page *page,
356                                             enum mem_cgroup_page_stat_item idx)
357 {
358 }
359
360 static inline void mem_cgroup_dec_page_stat(struct page *page,
361                                             enum mem_cgroup_page_stat_item idx)
362 {
363 }
364
365 static inline
366 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
367                                             gfp_t gfp_mask,
368                                             unsigned long *total_scanned)
369 {
370         return 0;
371 }
372
373 static inline void mem_cgroup_split_huge_fixup(struct page *head)
374 {
375 }
376
377 static inline
378 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
379 {
380 }
381 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
382                                 struct page *newpage)
383 {
384 }
385 #endif /* CONFIG_MEMCG */
386
387 #if !defined(CONFIG_MEMCG) || !defined(CONFIG_DEBUG_VM)
388 static inline bool
389 mem_cgroup_bad_page_check(struct page *page)
390 {
391         return false;
392 }
393
394 static inline void
395 mem_cgroup_print_bad_page(struct page *page)
396 {
397 }
398 #endif
399
400 enum {
401         UNDER_LIMIT,
402         SOFT_LIMIT,
403         OVER_LIMIT,
404 };
405
406 struct sock;
407 #if defined(CONFIG_INET) && defined(CONFIG_MEMCG_KMEM)
408 void sock_update_memcg(struct sock *sk);
409 void sock_release_memcg(struct sock *sk);
410 #else
411 static inline void sock_update_memcg(struct sock *sk)
412 {
413 }
414 static inline void sock_release_memcg(struct sock *sk)
415 {
416 }
417 #endif /* CONFIG_INET && CONFIG_MEMCG_KMEM */
418
419 #ifdef CONFIG_MEMCG_KMEM
420 static inline bool memcg_kmem_enabled(void)
421 {
422         return true;
423 }
424
425 /*
426  * In general, we'll do everything in our power to not incur in any overhead
427  * for non-memcg users for the kmem functions. Not even a function call, if we
428  * can avoid it.
429  *
430  * Therefore, we'll inline all those functions so that in the best case, we'll
431  * see that kmemcg is off for everybody and proceed quickly.  If it is on,
432  * we'll still do most of the flag checking inline. We check a lot of
433  * conditions, but because they are pretty simple, they are expected to be
434  * fast.
435  */
436 bool __memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg,
437                                         int order);
438 void __memcg_kmem_commit_charge(struct page *page,
439                                        struct mem_cgroup *memcg, int order);
440 void __memcg_kmem_uncharge_pages(struct page *page, int order);
441
442 /**
443  * memcg_kmem_newpage_charge: verify if a new kmem allocation is allowed.
444  * @gfp: the gfp allocation flags.
445  * @memcg: a pointer to the memcg this was charged against.
446  * @order: allocation order.
447  *
448  * returns true if the memcg where the current task belongs can hold this
449  * allocation.
450  *
451  * We return true automatically if this allocation is not to be accounted to
452  * any memcg.
453  */
454 static inline bool
455 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
456 {
457         if (!memcg_kmem_enabled())
458                 return true;
459
460         /*
461          * __GFP_NOFAIL allocations will move on even if charging is not
462          * possible. Therefore we don't even try, and have this allocation
463          * unaccounted. We could in theory charge it with
464          * res_counter_charge_nofail, but we hope those allocations are rare,
465          * and won't be worth the trouble.
466          */
467         if (!(gfp & __GFP_KMEMCG) || (gfp & __GFP_NOFAIL))
468                 return true;
469         if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
470                 return true;
471
472         /* If the test is dying, just let it go. */
473         if (unlikely(fatal_signal_pending(current)))
474                 return true;
475
476         return __memcg_kmem_newpage_charge(gfp, memcg, order);
477 }
478
479 /**
480  * memcg_kmem_uncharge_pages: uncharge pages from memcg
481  * @page: pointer to struct page being freed
482  * @order: allocation order.
483  *
484  * there is no need to specify memcg here, since it is embedded in page_cgroup
485  */
486 static inline void
487 memcg_kmem_uncharge_pages(struct page *page, int order)
488 {
489         if (memcg_kmem_enabled())
490                 __memcg_kmem_uncharge_pages(page, order);
491 }
492
493 /**
494  * memcg_kmem_commit_charge: embeds correct memcg in a page
495  * @page: pointer to struct page recently allocated
496  * @memcg: the memcg structure we charged against
497  * @order: allocation order.
498  *
499  * Needs to be called after memcg_kmem_newpage_charge, regardless of success or
500  * failure of the allocation. if @page is NULL, this function will revert the
501  * charges. Otherwise, it will commit the memcg given by @memcg to the
502  * corresponding page_cgroup.
503  */
504 static inline void
505 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
506 {
507         if (memcg_kmem_enabled() && memcg)
508                 __memcg_kmem_commit_charge(page, memcg, order);
509 }
510
511 #else
512 static inline bool
513 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
514 {
515         return true;
516 }
517
518 static inline void memcg_kmem_uncharge_pages(struct page *page, int order)
519 {
520 }
521
522 static inline void
523 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
524 {
525 }
526 #endif /* CONFIG_MEMCG_KMEM */
527 #endif /* _LINUX_MEMCONTROL_H */
528