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