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 struct kmem_cache;
  32
  33 /* Stats that can be updated by kernel. */
  34 enum mem_cgroup_page_stat_item {
  35         MEMCG_NR_FILE_MAPPED, /* # of pages charged as file rss */
  36 };
  37
  38 struct mem_cgroup_reclaim_cookie {
  39         struct zone *zone;
  40         int priority;
  41         unsigned int generation;
  42 };
  43
  44 #ifdef CONFIG_MEMCG
  45 /*
  46  * All "charge" functions with gfp_mask should use GFP_KERNEL or
  47  * (gfp_mask & GFP_RECLAIM_MASK). In current implementatin, memcg doesn't
  48  * alloc memory but reclaims memory from all available zones. So, "where I want
  49  * memory from" bits of gfp_mask has no meaning. So any bits of that field is
  50  * available but adding a rule is better. charge functions' gfp_mask should
  51  * be set to GFP_KERNEL or gfp_mask & GFP_RECLAIM_MASK for avoiding ambiguous
  52  * codes.
  53  * (Of course, if memcg does memory allocation in future, GFP_KERNEL is sane.)
  54  */
  55
  56 extern int mem_cgroup_newpage_charge(struct page *page, struct mm_struct *mm,
  57                                 gfp_t gfp_mask);
  58 /* for swap handling */
  59 extern int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
  60                 struct page *page, gfp_t mask, struct mem_cgroup **memcgp);
  61 extern void mem_cgroup_commit_charge_swapin(struct page *page,
  62                                         struct mem_cgroup *memcg);
  63 extern void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg);
  64
  65 extern int mem_cgroup_cache_charge(struct page *page, struct mm_struct *mm,
  66                                         gfp_t gfp_mask);
  67
  68 struct lruvec *mem_cgroup_zone_lruvec(struct zone *, struct mem_cgroup *);
  69 struct lruvec *mem_cgroup_page_lruvec(struct page *, struct zone *);
  70
  71 /* For coalescing uncharge for reducing memcg' overhead*/
  72 extern void mem_cgroup_uncharge_start(void);
  73 extern void mem_cgroup_uncharge_end(void);
  74
  75 extern void mem_cgroup_uncharge_page(struct page *page);
  76 extern void mem_cgroup_uncharge_cache_page(struct page *page);
  77
  78 bool __mem_cgroup_same_or_subtree(const struct mem_cgroup *root_memcg,
  79                                   struct mem_cgroup *memcg);
  80 bool task_in_mem_cgroup(struct task_struct *task,
  81                         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_css(struct cgroup_subsys_state *css);
  89
  90 static inline
  91 bool mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *memcg)
  92 {
  93         struct mem_cgroup *task_memcg;
  94         bool match;
  95
  96         rcu_read_lock();
  97         task_memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
  98         match = __mem_cgroup_same_or_subtree(memcg, task_memcg);
  99         rcu_read_unlock();
 100         return match;
 101 }
 102
 103 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
 104
 105 extern void
 106 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
 107                              struct mem_cgroup **memcgp);
 108 extern void mem_cgroup_end_migration(struct mem_cgroup *memcg,
 109         struct page *oldpage, struct page *newpage, bool migration_ok);
 110
 111 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
 112                                    struct mem_cgroup *,
 113                                    struct mem_cgroup_reclaim_cookie *);
 114 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
 115
 116 /*
 117  * For memory reclaim.
 118  */
 119 int mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec);
 120 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
 121 unsigned long mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list);
 122 void mem_cgroup_update_lru_size(struct lruvec *, enum lru_list, int);
 123 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
 124                                         struct task_struct *p);
 125 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
 126                                         struct page *newpage);
 127
 128 #ifdef CONFIG_MEMCG_SWAP
 129 extern int do_swap_account;
 130 #endif
 131
 132 static inline bool mem_cgroup_disabled(void)
 133 {
 134         if (mem_cgroup_subsys.disabled)
 135                 return true;
 136         return false;
 137 }
 138
 139 void __mem_cgroup_begin_update_page_stat(struct page *page, bool *locked,
 140                                          unsigned long *flags);
 141
 142 extern atomic_t memcg_moving;
 143
 144 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 145                                         bool *locked, unsigned long *flags)
 146 {
 147         if (mem_cgroup_disabled())
 148                 return;
 149         rcu_read_lock();
 150         *locked = false;
 151         if (atomic_read(&memcg_moving))
 152                 __mem_cgroup_begin_update_page_stat(page, locked, flags);
 153 }
 154
 155 void __mem_cgroup_end_update_page_stat(struct page *page,
 156                                 unsigned long *flags);
 157 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 158                                         bool *locked, unsigned long *flags)
 159 {
 160         if (mem_cgroup_disabled())
 161                 return;
 162         if (*locked)
 163                 __mem_cgroup_end_update_page_stat(page, flags);
 164         rcu_read_unlock();
 165 }
 166
 167 void mem_cgroup_update_page_stat(struct page *page,
 168                                  enum mem_cgroup_page_stat_item idx,
 169                                  int val);
 170
 171 static inline void mem_cgroup_inc_page_stat(struct page *page,
 172                                             enum mem_cgroup_page_stat_item idx)
 173 {
 174         mem_cgroup_update_page_stat(page, idx, 1);
 175 }
 176
 177 static inline void mem_cgroup_dec_page_stat(struct page *page,
 178                                             enum mem_cgroup_page_stat_item idx)
 179 {
 180         mem_cgroup_update_page_stat(page, idx, -1);
 181 }
 182
 183 bool mem_cgroup_soft_reclaim_eligible(struct mem_cgroup *memcg);
 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 bool task_in_mem_cgroup(struct task_struct *task,
 276                                       const struct mem_cgroup *memcg)
 277 {
 278         return true;
 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 unsigned long
 323 mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list lru)
 324 {
 325         return 0;
 326 }
 327
 328 static inline void
 329 mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
 330                               int increment)
 331 {
 332 }
 333
 334 static inline void
 335 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
 336 {
 337 }
 338
 339 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 340                                         bool *locked, unsigned long *flags)
 341 {
 342 }
 343
 344 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 345                                         bool *locked, unsigned long *flags)
 346 {
 347 }
 348
 349 static inline void mem_cgroup_inc_page_stat(struct page *page,
 350                                             enum mem_cgroup_page_stat_item idx)
 351 {
 352 }
 353
 354 static inline void mem_cgroup_dec_page_stat(struct page *page,
 355                                             enum mem_cgroup_page_stat_item idx)
 356 {
 357 }
 358
 359 static inline
 360 bool mem_cgroup_soft_reclaim_eligible(struct mem_cgroup *memcg)
 361 {
 362         return false;
 363 }
 364
 365 static inline void mem_cgroup_split_huge_fixup(struct page *head)
 366 {
 367 }
 368
 369 static inline
 370 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
 371 {
 372 }
 373 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
 374                                 struct page *newpage)
 375 {
 376 }
 377 #endif /* CONFIG_MEMCG */
 378
 379 #if !defined(CONFIG_MEMCG) || !defined(CONFIG_DEBUG_VM)
 380 static inline bool
 381 mem_cgroup_bad_page_check(struct page *page)
 382 {
 383         return false;
 384 }
 385
 386 static inline void
 387 mem_cgroup_print_bad_page(struct page *page)
 388 {
 389 }
 390 #endif
 391
 392 enum {
 393         UNDER_LIMIT,
 394         SOFT_LIMIT,
 395         OVER_LIMIT,
 396 };
 397
 398 struct sock;
 399 #if defined(CONFIG_INET) && defined(CONFIG_MEMCG_KMEM)
 400 void sock_update_memcg(struct sock *sk);
 401 void sock_release_memcg(struct sock *sk);
 402 #else
 403 static inline void sock_update_memcg(struct sock *sk)
 404 {
 405 }
 406 static inline void sock_release_memcg(struct sock *sk)
 407 {
 408 }
 409 #endif /* CONFIG_INET && CONFIG_MEMCG_KMEM */
 410
 411 #ifdef CONFIG_MEMCG_KMEM
 412 extern struct static_key memcg_kmem_enabled_key;
 413
 414 extern int memcg_limited_groups_array_size;
 415
 416 /*
 417  * Helper macro to loop through all memcg-specific caches. Callers must still
 418  * check if the cache is valid (it is either valid or NULL).
 419  * the slab_mutex must be held when looping through those caches
 420  */
 421 #define for_each_memcg_cache_index(_idx)        \
 422         for ((_idx) = 0; (_idx) < memcg_limited_groups_array_size; (_idx)++)
 423
 424 static inline bool memcg_kmem_enabled(void)
 425 {
 426         return static_key_false(&memcg_kmem_enabled_key);
 427 }
 428
 429 /*
 430  * In general, we'll do everything in our power to not incur in any overhead
 431  * for non-memcg users for the kmem functions. Not even a function call, if we
 432  * can avoid it.
 433  *
 434  * Therefore, we'll inline all those functions so that in the best case, we'll
 435  * see that kmemcg is off for everybody and proceed quickly.  If it is on,
 436  * we'll still do most of the flag checking inline. We check a lot of
 437  * conditions, but because they are pretty simple, they are expected to be
 438  * fast.
 439  */
 440 bool __memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg,
 441                                         int order);
 442 void __memcg_kmem_commit_charge(struct page *page,
 443                                        struct mem_cgroup *memcg, int order);
 444 void __memcg_kmem_uncharge_pages(struct page *page, int order);
 445
 446 int memcg_cache_id(struct mem_cgroup *memcg);
 447 int memcg_register_cache(struct mem_cgroup *memcg, struct kmem_cache *s,
 448                          struct kmem_cache *root_cache);
 449 void memcg_release_cache(struct kmem_cache *cachep);
 450 void memcg_cache_list_add(struct mem_cgroup *memcg, struct kmem_cache *cachep);
 451
 452 int memcg_update_cache_size(struct kmem_cache *s, int num_groups);
 453 void memcg_update_array_size(int num_groups);
 454
 455 struct kmem_cache *
 456 __memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp);
 457
 458 void mem_cgroup_destroy_cache(struct kmem_cache *cachep);
 459 void kmem_cache_destroy_memcg_children(struct kmem_cache *s);
 460
 461 /**
 462  * memcg_kmem_newpage_charge: verify if a new kmem allocation is allowed.
 463  * @gfp: the gfp allocation flags.
 464  * @memcg: a pointer to the memcg this was charged against.
 465  * @order: allocation order.
 466  *
 467  * returns true if the memcg where the current task belongs can hold this
 468  * allocation.
 469  *
 470  * We return true automatically if this allocation is not to be accounted to
 471  * any memcg.
 472  */
 473 static inline bool
 474 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
 475 {
 476         if (!memcg_kmem_enabled())
 477                 return true;
 478
 479         /*
 480          * __GFP_NOFAIL allocations will move on even if charging is not
 481          * possible. Therefore we don't even try, and have this allocation
 482          * unaccounted. We could in theory charge it with
 483          * res_counter_charge_nofail, but we hope those allocations are rare,
 484          * and won't be worth the trouble.
 485          */
 486         if (!(gfp & __GFP_KMEMCG) || (gfp & __GFP_NOFAIL))
 487                 return true;
 488         if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
 489                 return true;
 490
 491         /* If the test is dying, just let it go. */
 492         if (unlikely(fatal_signal_pending(current)))
 493                 return true;
 494
 495         return __memcg_kmem_newpage_charge(gfp, memcg, order);
 496 }
 497
 498 /**
 499  * memcg_kmem_uncharge_pages: uncharge pages from memcg
 500  * @page: pointer to struct page being freed
 501  * @order: allocation order.
 502  *
 503  * there is no need to specify memcg here, since it is embedded in page_cgroup
 504  */
 505 static inline void
 506 memcg_kmem_uncharge_pages(struct page *page, int order)
 507 {
 508         if (memcg_kmem_enabled())
 509                 __memcg_kmem_uncharge_pages(page, order);
 510 }
 511
 512 /**
 513  * memcg_kmem_commit_charge: embeds correct memcg in a page
 514  * @page: pointer to struct page recently allocated
 515  * @memcg: the memcg structure we charged against
 516  * @order: allocation order.
 517  *
 518  * Needs to be called after memcg_kmem_newpage_charge, regardless of success or
 519  * failure of the allocation. if @page is NULL, this function will revert the
 520  * charges. Otherwise, it will commit the memcg given by @memcg to the
 521  * corresponding page_cgroup.
 522  */
 523 static inline void
 524 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
 525 {
 526         if (memcg_kmem_enabled() && memcg)
 527                 __memcg_kmem_commit_charge(page, memcg, order);
 528 }
 529
 530 /**
 531  * memcg_kmem_get_cache: selects the correct per-memcg cache for allocation
 532  * @cachep: the original global kmem cache
 533  * @gfp: allocation flags.
 534  *
 535  * This function assumes that the task allocating, which determines the memcg
 536  * in the page allocator, belongs to the same cgroup throughout the whole
 537  * process.  Misacounting can happen if the task calls memcg_kmem_get_cache()
 538  * while belonging to a cgroup, and later on changes. This is considered
 539  * acceptable, and should only happen upon task migration.
 540  *
 541  * Before the cache is created by the memcg core, there is also a possible
 542  * imbalance: the task belongs to a memcg, but the cache being allocated from
 543  * is the global cache, since the child cache is not yet guaranteed to be
 544  * ready. This case is also fine, since in this case the GFP_KMEMCG will not be
 545  * passed and the page allocator will not attempt any cgroup accounting.
 546  */
 547 static __always_inline struct kmem_cache *
 548 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
 549 {
 550         if (!memcg_kmem_enabled())
 551                 return cachep;
 552         if (gfp & __GFP_NOFAIL)
 553                 return cachep;
 554         if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
 555                 return cachep;
 556         if (unlikely(fatal_signal_pending(current)))
 557                 return cachep;
 558
 559         return __memcg_kmem_get_cache(cachep, gfp);
 560 }
 561 #else
 562 #define for_each_memcg_cache_index(_idx)        \
 563         for (; NULL; )
 564
 565 static inline bool memcg_kmem_enabled(void)
 566 {
 567         return false;
 568 }
 569
 570 static inline bool
 571 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
 572 {
 573         return true;
 574 }
 575
 576 static inline void memcg_kmem_uncharge_pages(struct page *page, int order)
 577 {
 578 }
 579
 580 static inline void
 581 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
 582 {
 583 }
 584
 585 static inline int memcg_cache_id(struct mem_cgroup *memcg)
 586 {
 587         return -1;
 588 }
 589
 590 static inline int
 591 memcg_register_cache(struct mem_cgroup *memcg, struct kmem_cache *s,
 592                      struct kmem_cache *root_cache)
 593 {
 594         return 0;
 595 }
 596
 597 static inline void memcg_release_cache(struct kmem_cache *cachep)
 598 {
 599 }
 600
 601 static inline void memcg_cache_list_add(struct mem_cgroup *memcg,
 602                                         struct kmem_cache *s)
 603 {
 604 }
 605
 606 static inline struct kmem_cache *
 607 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
 608 {
 609         return cachep;
 610 }
 611
 612 static inline void kmem_cache_destroy_memcg_children(struct kmem_cache *s)
 613 {
 614 }
 615 #endif /* CONFIG_MEMCG_KMEM */
 616 #endif /* _LINUX_MEMCONTROL_H */
 617