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
  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 struct mem_cgroup_reclaim_cookie {
  36         struct zone *zone;
  37         int priority;
  38         unsigned int generation;
  39 };
  40
  41 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
  42 /*
  43  * All "charge" functions with gfp_mask should use GFP_KERNEL or
  44  * (gfp_mask & GFP_RECLAIM_MASK). In current implementatin, memcg doesn't
  45  * alloc memory but reclaims memory from all available zones. So, "where I want
  46  * memory from" bits of gfp_mask has no meaning. So any bits of that field is
  47  * available but adding a rule is better. charge functions' gfp_mask should
  48  * be set to GFP_KERNEL or gfp_mask & GFP_RECLAIM_MASK for avoiding ambiguous
  49  * codes.
  50  * (Of course, if memcg does memory allocation in future, GFP_KERNEL is sane.)
  51  */
  52
  53 extern int mem_cgroup_newpage_charge(struct page *page, struct mm_struct *mm,
  54                                 gfp_t gfp_mask);
  55 /* for swap handling */
  56 extern int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
  57                 struct page *page, gfp_t mask, struct mem_cgroup **memcgp);
  58 extern void mem_cgroup_commit_charge_swapin(struct page *page,
  59                                         struct mem_cgroup *memcg);
  60 extern void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg);
  61
  62 extern int mem_cgroup_cache_charge(struct page *page, struct mm_struct *mm,
  63                                         gfp_t gfp_mask);
  64
  65 struct lruvec *mem_cgroup_zone_lruvec(struct zone *, struct mem_cgroup *);
  66 struct lruvec *mem_cgroup_lru_add_list(struct zone *, struct page *,
  67                                        enum lru_list);
  68 void mem_cgroup_lru_del_list(struct page *, enum lru_list);
  69 struct lruvec *mem_cgroup_lru_move_lists(struct zone *, struct page *,
  70                                          enum lru_list, enum lru_list);
  71
  72 /* For coalescing uncharge for reducing memcg' overhead*/
  73 extern void mem_cgroup_uncharge_start(void);
  74 extern void mem_cgroup_uncharge_end(void);
  75
  76 extern void mem_cgroup_uncharge_page(struct page *page);
  77 extern void mem_cgroup_uncharge_cache_page(struct page *page);
  78
  79 extern void mem_cgroup_out_of_memory(struct mem_cgroup *memcg, gfp_t gfp_mask,
  80                                      int order);
  81 bool __mem_cgroup_same_or_subtree(const struct mem_cgroup *root_memcg,
  82                                   struct mem_cgroup *memcg);
  83 int task_in_mem_cgroup(struct task_struct *task, const struct mem_cgroup *memcg);
  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 extern struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm);
  88
  89 extern struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg);
  90 extern struct mem_cgroup *mem_cgroup_from_cont(struct cgroup *cont);
  91
  92 static inline
  93 int mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *cgroup)
  94 {
  95         struct mem_cgroup *memcg;
  96         int match;
  97
  98         rcu_read_lock();
  99         memcg = mem_cgroup_from_task(rcu_dereference((mm)->owner));
 100         match = __mem_cgroup_same_or_subtree(cgroup, memcg);
 101         rcu_read_unlock();
 102         return match;
 103 }
 104
 105 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
 106
 107 extern int
 108 mem_cgroup_prepare_migration(struct page *page,
 109         struct page *newpage, struct mem_cgroup **memcgp, gfp_t gfp_mask);
 110 extern void mem_cgroup_end_migration(struct mem_cgroup *memcg,
 111         struct page *oldpage, struct page *newpage, bool migration_ok);
 112
 113 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
 114                                    struct mem_cgroup *,
 115                                    struct mem_cgroup_reclaim_cookie *);
 116 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
 117
 118 /*
 119  * For memory reclaim.
 120  */
 121 int mem_cgroup_inactive_anon_is_low(struct mem_cgroup *memcg,
 122                                     struct zone *zone);
 123 int mem_cgroup_inactive_file_is_low(struct mem_cgroup *memcg,
 124                                     struct zone *zone);
 125 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
 126 unsigned long mem_cgroup_get_lruvec_size(struct lruvec *lruvec, enum lru_list);
 127 struct zone_reclaim_stat*
 128 mem_cgroup_get_reclaim_stat_from_page(struct page *page);
 129 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
 130                                         struct task_struct *p);
 131 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
 132                                         struct page *newpage);
 133
 134 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_SWAP
 135 extern int do_swap_account;
 136 #endif
 137
 138 static inline bool mem_cgroup_disabled(void)
 139 {
 140         if (mem_cgroup_subsys.disabled)
 141                 return true;
 142         return false;
 143 }
 144
 145 void __mem_cgroup_begin_update_page_stat(struct page *page, bool *locked,
 146                                          unsigned long *flags);
 147
 148 extern atomic_t memcg_moving;
 149
 150 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 151                                         bool *locked, unsigned long *flags)
 152 {
 153         if (mem_cgroup_disabled())
 154                 return;
 155         rcu_read_lock();
 156         *locked = false;
 157         if (atomic_read(&memcg_moving))
 158                 __mem_cgroup_begin_update_page_stat(page, locked, flags);
 159 }
 160
 161 void __mem_cgroup_end_update_page_stat(struct page *page,
 162                                 unsigned long *flags);
 163 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 164                                         bool *locked, unsigned long *flags)
 165 {
 166         if (mem_cgroup_disabled())
 167                 return;
 168         if (*locked)
 169                 __mem_cgroup_end_update_page_stat(page, flags);
 170         rcu_read_unlock();
 171 }
 172
 173 void mem_cgroup_update_page_stat(struct page *page,
 174                                  enum mem_cgroup_page_stat_item idx,
 175                                  int val);
 176
 177 static inline void mem_cgroup_inc_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 static inline void mem_cgroup_dec_page_stat(struct page *page,
 184                                             enum mem_cgroup_page_stat_item idx)
 185 {
 186         mem_cgroup_update_page_stat(page, idx, -1);
 187 }
 188
 189 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
 190                                                 gfp_t gfp_mask,
 191                                                 unsigned long *total_scanned);
 192 u64 mem_cgroup_get_limit(struct mem_cgroup *memcg);
 193
 194 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
 195 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 196 void mem_cgroup_split_huge_fixup(struct page *head);
 197 #endif
 198
 199 #ifdef CONFIG_DEBUG_VM
 200 bool mem_cgroup_bad_page_check(struct page *page);
 201 void mem_cgroup_print_bad_page(struct page *page);
 202 #endif
 203 #else /* CONFIG_CGROUP_MEM_RES_CTLR */
 204 struct mem_cgroup;
 205
 206 static inline int mem_cgroup_newpage_charge(struct page *page,
 207                                         struct mm_struct *mm, gfp_t gfp_mask)
 208 {
 209         return 0;
 210 }
 211
 212 static inline int mem_cgroup_cache_charge(struct page *page,
 213                                         struct mm_struct *mm, gfp_t gfp_mask)
 214 {
 215         return 0;
 216 }
 217
 218 static inline int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
 219                 struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
 220 {
 221         return 0;
 222 }
 223
 224 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
 225                                           struct mem_cgroup *memcg)
 226 {
 227 }
 228
 229 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
 230 {
 231 }
 232
 233 static inline void mem_cgroup_uncharge_start(void)
 234 {
 235 }
 236
 237 static inline void mem_cgroup_uncharge_end(void)
 238 {
 239 }
 240
 241 static inline void mem_cgroup_uncharge_page(struct page *page)
 242 {
 243 }
 244
 245 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
 246 {
 247 }
 248
 249 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
 250                                                     struct mem_cgroup *memcg)
 251 {
 252         return &zone->lruvec;
 253 }
 254
 255 static inline struct lruvec *mem_cgroup_lru_add_list(struct zone *zone,
 256                                                      struct page *page,
 257                                                      enum lru_list lru)
 258 {
 259         return &zone->lruvec;
 260 }
 261
 262 static inline void mem_cgroup_lru_del_list(struct page *page, enum lru_list lru)
 263 {
 264 }
 265
 266 static inline struct lruvec *mem_cgroup_lru_move_lists(struct zone *zone,
 267                                                        struct page *page,
 268                                                        enum lru_list from,
 269                                                        enum lru_list to)
 270 {
 271         return &zone->lruvec;
 272 }
 273
 274 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
 275 {
 276         return NULL;
 277 }
 278
 279 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
 280 {
 281         return NULL;
 282 }
 283
 284 static inline int mm_match_cgroup(struct mm_struct *mm,
 285                 struct mem_cgroup *memcg)
 286 {
 287         return 1;
 288 }
 289
 290 static inline int task_in_mem_cgroup(struct task_struct *task,
 291                                      const struct mem_cgroup *memcg)
 292 {
 293         return 1;
 294 }
 295
 296 static inline struct cgroup_subsys_state
 297                 *mem_cgroup_css(struct mem_cgroup *memcg)
 298 {
 299         return NULL;
 300 }
 301
 302 static inline int
 303 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
 304         struct mem_cgroup **memcgp, gfp_t gfp_mask)
 305 {
 306         return 0;
 307 }
 308
 309 static inline void mem_cgroup_end_migration(struct mem_cgroup *memcg,
 310                 struct page *oldpage, struct page *newpage, bool migration_ok)
 311 {
 312 }
 313
 314 static inline struct mem_cgroup *
 315 mem_cgroup_iter(struct mem_cgroup *root,
 316                 struct mem_cgroup *prev,
 317                 struct mem_cgroup_reclaim_cookie *reclaim)
 318 {
 319         return NULL;
 320 }
 321
 322 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
 323                                          struct mem_cgroup *prev)
 324 {
 325 }
 326
 327 static inline bool mem_cgroup_disabled(void)
 328 {
 329         return true;
 330 }
 331
 332 static inline int
 333 mem_cgroup_inactive_anon_is_low(struct mem_cgroup *memcg, struct zone *zone)
 334 {
 335         return 1;
 336 }
 337
 338 static inline int
 339 mem_cgroup_inactive_file_is_low(struct mem_cgroup *memcg, struct zone *zone)
 340 {
 341         return 1;
 342 }
 343
 344 static inline unsigned long
 345 mem_cgroup_get_lruvec_size(struct lruvec *lruvec, enum lru_list lru)
 346 {
 347         return 0;
 348 }
 349
 350 static inline struct zone_reclaim_stat*
 351 mem_cgroup_get_reclaim_stat_from_page(struct page *page)
 352 {
 353         return NULL;
 354 }
 355
 356 static inline void
 357 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
 358 {
 359 }
 360
 361 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 362                                         bool *locked, unsigned long *flags)
 363 {
 364 }
 365
 366 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 367                                         bool *locked, unsigned long *flags)
 368 {
 369 }
 370
 371 static inline void mem_cgroup_inc_page_stat(struct page *page,
 372                                             enum mem_cgroup_page_stat_item idx)
 373 {
 374 }
 375
 376 static inline void mem_cgroup_dec_page_stat(struct page *page,
 377                                             enum mem_cgroup_page_stat_item idx)
 378 {
 379 }
 380
 381 static inline
 382 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
 383                                             gfp_t gfp_mask,
 384                                             unsigned long *total_scanned)
 385 {
 386         return 0;
 387 }
 388
 389 static inline
 390 u64 mem_cgroup_get_limit(struct mem_cgroup *memcg)
 391 {
 392         return 0;
 393 }
 394
 395 static inline void mem_cgroup_split_huge_fixup(struct page *head)
 396 {
 397 }
 398
 399 static inline
 400 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
 401 {
 402 }
 403 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
 404                                 struct page *newpage)
 405 {
 406 }
 407 #endif /* CONFIG_CGROUP_MEM_RES_CTLR */
 408
 409 #if !defined(CONFIG_CGROUP_MEM_RES_CTLR) || !defined(CONFIG_DEBUG_VM)
 410 static inline bool
 411 mem_cgroup_bad_page_check(struct page *page)
 412 {
 413         return false;
 414 }
 415
 416 static inline void
 417 mem_cgroup_print_bad_page(struct page *page)
 418 {
 419 }
 420 #endif
 421
 422 enum {
 423         UNDER_LIMIT,
 424         SOFT_LIMIT,
 425         OVER_LIMIT,
 426 };
 427
 428 struct sock;
 429 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
 430 void sock_update_memcg(struct sock *sk);
 431 void sock_release_memcg(struct sock *sk);
 432 #else
 433 static inline void sock_update_memcg(struct sock *sk)
 434 {
 435 }
 436 static inline void sock_release_memcg(struct sock *sk)
 437 {
 438 }
 439 #endif /* CONFIG_CGROUP_MEM_RES_CTLR_KMEM */
 440 #endif /* _LINUX_MEMCONTROL_H */
 441