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 int task_in_mem_cgroup(struct task_struct *task, const struct mem_cgroup *memcg);
  81
  82 extern struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page);
  83 extern struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
  84 extern struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm);
  85
  86 extern struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg);
  87 extern struct mem_cgroup *mem_cgroup_from_cont(struct cgroup *cont);
  88
  89 static inline
  90 bool mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *memcg)
  91 {
  92         struct mem_cgroup *task_memcg;
  93         bool match;
  94
  95         rcu_read_lock();
  96         task_memcg = mem_cgroup_from_task(rcu_dereference(mm->owner));
  97         match = __mem_cgroup_same_or_subtree(memcg, task_memcg);
  98         rcu_read_unlock();
  99         return match;
 100 }
 101
 102 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
 103
 104 extern void
 105 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
 106                              struct mem_cgroup **memcgp);
 107 extern void mem_cgroup_end_migration(struct mem_cgroup *memcg,
 108         struct page *oldpage, struct page *newpage, bool migration_ok);
 109
 110 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
 111                                    struct mem_cgroup *,
 112                                    struct mem_cgroup_reclaim_cookie *);
 113 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
 114
 115 /*
 116  * For memory reclaim.
 117  */
 118 int mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec);
 119 int mem_cgroup_inactive_file_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 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
 184                                                 gfp_t gfp_mask,
 185                                                 unsigned long *total_scanned);
 186
 187 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
 188 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 189 void mem_cgroup_split_huge_fixup(struct page *head);
 190 #endif
 191
 192 #ifdef CONFIG_DEBUG_VM
 193 bool mem_cgroup_bad_page_check(struct page *page);
 194 void mem_cgroup_print_bad_page(struct page *page);
 195 #endif
 196 #else /* CONFIG_MEMCG */
 197 struct mem_cgroup;
 198
 199 static inline int mem_cgroup_newpage_charge(struct page *page,
 200                                         struct mm_struct *mm, gfp_t gfp_mask)
 201 {
 202         return 0;
 203 }
 204
 205 static inline int mem_cgroup_cache_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_try_charge_swapin(struct mm_struct *mm,
 212                 struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
 213 {
 214         return 0;
 215 }
 216
 217 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
 218                                           struct mem_cgroup *memcg)
 219 {
 220 }
 221
 222 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
 223 {
 224 }
 225
 226 static inline void mem_cgroup_uncharge_start(void)
 227 {
 228 }
 229
 230 static inline void mem_cgroup_uncharge_end(void)
 231 {
 232 }
 233
 234 static inline void mem_cgroup_uncharge_page(struct page *page)
 235 {
 236 }
 237
 238 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
 239 {
 240 }
 241
 242 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
 243                                                     struct mem_cgroup *memcg)
 244 {
 245         return &zone->lruvec;
 246 }
 247
 248 static inline struct lruvec *mem_cgroup_page_lruvec(struct page *page,
 249                                                     struct zone *zone)
 250 {
 251         return &zone->lruvec;
 252 }
 253
 254 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
 255 {
 256         return NULL;
 257 }
 258
 259 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
 260 {
 261         return NULL;
 262 }
 263
 264 static inline bool mm_match_cgroup(struct mm_struct *mm,
 265                 struct mem_cgroup *memcg)
 266 {
 267         return true;
 268 }
 269
 270 static inline int task_in_mem_cgroup(struct task_struct *task,
 271                                      const struct mem_cgroup *memcg)
 272 {
 273         return 1;
 274 }
 275
 276 static inline struct cgroup_subsys_state
 277                 *mem_cgroup_css(struct mem_cgroup *memcg)
 278 {
 279         return NULL;
 280 }
 281
 282 static inline void
 283 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
 284                              struct mem_cgroup **memcgp)
 285 {
 286 }
 287
 288 static inline void mem_cgroup_end_migration(struct mem_cgroup *memcg,
 289                 struct page *oldpage, struct page *newpage, bool migration_ok)
 290 {
 291 }
 292
 293 static inline struct mem_cgroup *
 294 mem_cgroup_iter(struct mem_cgroup *root,
 295                 struct mem_cgroup *prev,
 296                 struct mem_cgroup_reclaim_cookie *reclaim)
 297 {
 298         return NULL;
 299 }
 300
 301 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
 302                                          struct mem_cgroup *prev)
 303 {
 304 }
 305
 306 static inline bool mem_cgroup_disabled(void)
 307 {
 308         return true;
 309 }
 310
 311 static inline int
 312 mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec)
 313 {
 314         return 1;
 315 }
 316
 317 static inline int
 318 mem_cgroup_inactive_file_is_low(struct lruvec *lruvec)
 319 {
 320         return 1;
 321 }
 322
 323 static inline unsigned long
 324 mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list lru)
 325 {
 326         return 0;
 327 }
 328
 329 static inline void
 330 mem_cgroup_update_lru_size(struct lruvec *lruvec, enum lru_list lru,
 331                               int increment)
 332 {
 333 }
 334
 335 static inline void
 336 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
 337 {
 338 }
 339
 340 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 341                                         bool *locked, unsigned long *flags)
 342 {
 343 }
 344
 345 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 346                                         bool *locked, unsigned long *flags)
 347 {
 348 }
 349
 350 static inline void mem_cgroup_inc_page_stat(struct page *page,
 351                                             enum mem_cgroup_page_stat_item idx)
 352 {
 353 }
 354
 355 static inline void mem_cgroup_dec_page_stat(struct page *page,
 356                                             enum mem_cgroup_page_stat_item idx)
 357 {
 358 }
 359
 360 static inline
 361 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
 362                                             gfp_t gfp_mask,
 363                                             unsigned long *total_scanned)
 364 {
 365         return 0;
 366 }
 367
 368 static inline void mem_cgroup_split_huge_fixup(struct page *head)
 369 {
 370 }
 371
 372 static inline
 373 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
 374 {
 375 }
 376 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
 377                                 struct page *newpage)
 378 {
 379 }
 380 #endif /* CONFIG_MEMCG */
 381
 382 #if !defined(CONFIG_MEMCG) || !defined(CONFIG_DEBUG_VM)
 383 static inline bool
 384 mem_cgroup_bad_page_check(struct page *page)
 385 {
 386         return false;
 387 }
 388
 389 static inline void
 390 mem_cgroup_print_bad_page(struct page *page)
 391 {
 392 }
 393 #endif
 394
 395 enum {
 396         UNDER_LIMIT,
 397         SOFT_LIMIT,
 398         OVER_LIMIT,
 399 };
 400
 401 struct sock;
 402 #if defined(CONFIG_INET) && defined(CONFIG_MEMCG_KMEM)
 403 void sock_update_memcg(struct sock *sk);
 404 void sock_release_memcg(struct sock *sk);
 405 #else
 406 static inline void sock_update_memcg(struct sock *sk)
 407 {
 408 }
 409 static inline void sock_release_memcg(struct sock *sk)
 410 {
 411 }
 412 #endif /* CONFIG_INET && CONFIG_MEMCG_KMEM */
 413
 414 #ifdef CONFIG_MEMCG_KMEM
 415 extern struct static_key memcg_kmem_enabled_key;
 416
 417 extern int memcg_limited_groups_array_size;
 418 #define for_each_memcg_cache_index(_idx)        \
 419         for ((_idx) = 0; i < memcg_limited_groups_array_size; (_idx)++)
 420
 421 static inline bool memcg_kmem_enabled(void)
 422 {
 423         return static_key_false(&memcg_kmem_enabled_key);
 424 }
 425
 426 /*
 427  * In general, we'll do everything in our power to not incur in any overhead
 428  * for non-memcg users for the kmem functions. Not even a function call, if we
 429  * can avoid it.
 430  *
 431  * Therefore, we'll inline all those functions so that in the best case, we'll
 432  * see that kmemcg is off for everybody and proceed quickly.  If it is on,
 433  * we'll still do most of the flag checking inline. We check a lot of
 434  * conditions, but because they are pretty simple, they are expected to be
 435  * fast.
 436  */
 437 bool __memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg,
 438                                         int order);
 439 void __memcg_kmem_commit_charge(struct page *page,
 440                                        struct mem_cgroup *memcg, int order);
 441 void __memcg_kmem_uncharge_pages(struct page *page, int order);
 442
 443 int memcg_cache_id(struct mem_cgroup *memcg);
 444 int memcg_register_cache(struct mem_cgroup *memcg, struct kmem_cache *s);
 445 void memcg_release_cache(struct kmem_cache *cachep);
 446 void memcg_cache_list_add(struct mem_cgroup *memcg, struct kmem_cache *cachep);
 447
 448 int memcg_update_cache_size(struct kmem_cache *s, int num_groups);
 449 void memcg_update_array_size(int num_groups);
 450
 451 struct kmem_cache *
 452 __memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp);
 453
 454 void mem_cgroup_destroy_cache(struct kmem_cache *cachep);
 455 void kmem_cache_destroy_memcg_children(struct kmem_cache *s);
 456
 457 /**
 458  * memcg_kmem_newpage_charge: verify if a new kmem allocation is allowed.
 459  * @gfp: the gfp allocation flags.
 460  * @memcg: a pointer to the memcg this was charged against.
 461  * @order: allocation order.
 462  *
 463  * returns true if the memcg where the current task belongs can hold this
 464  * allocation.
 465  *
 466  * We return true automatically if this allocation is not to be accounted to
 467  * any memcg.
 468  */
 469 static __always_inline bool
 470 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
 471 {
 472         if (!memcg_kmem_enabled())
 473                 return true;
 474
 475         /*
 476          * __GFP_NOFAIL allocations will move on even if charging is not
 477          * possible. Therefore we don't even try, and have this allocation
 478          * unaccounted. We could in theory charge it with
 479          * res_counter_charge_nofail, but we hope those allocations are rare,
 480          * and won't be worth the trouble.
 481          */
 482         if (!(gfp & __GFP_KMEMCG) || (gfp & __GFP_NOFAIL))
 483                 return true;
 484         if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
 485                 return true;
 486
 487         /* If the test is dying, just let it go. */
 488         if (unlikely(fatal_signal_pending(current)))
 489                 return true;
 490
 491         return __memcg_kmem_newpage_charge(gfp, memcg, order);
 492 }
 493
 494 /**
 495  * memcg_kmem_uncharge_pages: uncharge pages from memcg
 496  * @page: pointer to struct page being freed
 497  * @order: allocation order.
 498  *
 499  * there is no need to specify memcg here, since it is embedded in page_cgroup
 500  */
 501 static __always_inline void
 502 memcg_kmem_uncharge_pages(struct page *page, int order)
 503 {
 504         if (memcg_kmem_enabled())
 505                 __memcg_kmem_uncharge_pages(page, order);
 506 }
 507
 508 /**
 509  * memcg_kmem_commit_charge: embeds correct memcg in a page
 510  * @page: pointer to struct page recently allocated
 511  * @memcg: the memcg structure we charged against
 512  * @order: allocation order.
 513  *
 514  * Needs to be called after memcg_kmem_newpage_charge, regardless of success or
 515  * failure of the allocation. if @page is NULL, this function will revert the
 516  * charges. Otherwise, it will commit the memcg given by @memcg to the
 517  * corresponding page_cgroup.
 518  */
 519 static __always_inline void
 520 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
 521 {
 522         if (memcg_kmem_enabled() && memcg)
 523                 __memcg_kmem_commit_charge(page, memcg, order);
 524 }
 525
 526 /**
 527  * memcg_kmem_get_cache: selects the correct per-memcg cache for allocation
 528  * @cachep: the original global kmem cache
 529  * @gfp: allocation flags.
 530  *
 531  * This function assumes that the task allocating, which determines the memcg
 532  * in the page allocator, belongs to the same cgroup throughout the whole
 533  * process.  Misacounting can happen if the task calls memcg_kmem_get_cache()
 534  * while belonging to a cgroup, and later on changes. This is considered
 535  * acceptable, and should only happen upon task migration.
 536  *
 537  * Before the cache is created by the memcg core, there is also a possible
 538  * imbalance: the task belongs to a memcg, but the cache being allocated from
 539  * is the global cache, since the child cache is not yet guaranteed to be
 540  * ready. This case is also fine, since in this case the GFP_KMEMCG will not be
 541  * passed and the page allocator will not attempt any cgroup accounting.
 542  */
 543 static __always_inline struct kmem_cache *
 544 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
 545 {
 546         if (!memcg_kmem_enabled())
 547                 return cachep;
 548         if (gfp & __GFP_NOFAIL)
 549                 return cachep;
 550         if (in_interrupt() || (!current->mm) || (current->flags & PF_KTHREAD))
 551                 return cachep;
 552         if (unlikely(fatal_signal_pending(current)))
 553                 return cachep;
 554
 555         return __memcg_kmem_get_cache(cachep, gfp);
 556 }
 557 #else
 558 #define for_each_memcg_cache_index(_idx)        \
 559         for (; NULL; )
 560
 561 static inline bool memcg_kmem_enabled(void)
 562 {
 563         return false;
 564 }
 565
 566 static inline bool
 567 memcg_kmem_newpage_charge(gfp_t gfp, struct mem_cgroup **memcg, int order)
 568 {
 569         return true;
 570 }
 571
 572 static inline void memcg_kmem_uncharge_pages(struct page *page, int order)
 573 {
 574 }
 575
 576 static inline void
 577 memcg_kmem_commit_charge(struct page *page, struct mem_cgroup *memcg, int order)
 578 {
 579 }
 580
 581 static inline int memcg_cache_id(struct mem_cgroup *memcg)
 582 {
 583         return -1;
 584 }
 585
 586 static inline int memcg_register_cache(struct mem_cgroup *memcg,
 587                                        struct kmem_cache *s)
 588 {
 589         return 0;
 590 }
 591
 592 static inline void memcg_release_cache(struct kmem_cache *cachep)
 593 {
 594 }
 595
 596 static inline void memcg_cache_list_add(struct mem_cgroup *memcg,
 597                                         struct kmem_cache *s)
 598 {
 599 }
 600
 601 static inline struct kmem_cache *
 602 memcg_kmem_get_cache(struct kmem_cache *cachep, gfp_t gfp)
 603 {
 604         return cachep;
 605 }
 606
 607 static inline void kmem_cache_destroy_memcg_children(struct kmem_cache *s)
 608 {
 609 }
 610 #endif /* CONFIG_MEMCG_KMEM */
 611 #endif /* _LINUX_MEMCONTROL_H */
 612