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_zone_nr_lru_pages(struct mem_cgroup *memcg,
 127                                         int nid, int zid, unsigned int lrumask);
 128 struct zone_reclaim_stat*
 129 mem_cgroup_get_reclaim_stat_from_page(struct page *page);
 130 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
 131                                         struct task_struct *p);
 132 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
 133                                         struct page *newpage);
 134
 135 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_SWAP
 136 extern int do_swap_account;
 137 #endif
 138
 139 static inline bool mem_cgroup_disabled(void)
 140 {
 141         if (mem_cgroup_subsys.disabled)
 142                 return true;
 143         return false;
 144 }
 145
 146 void __mem_cgroup_begin_update_page_stat(struct page *page, bool *locked,
 147                                          unsigned long *flags);
 148
 149 extern atomic_t memcg_moving;
 150
 151 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 152                                         bool *locked, unsigned long *flags)
 153 {
 154         if (mem_cgroup_disabled())
 155                 return;
 156         rcu_read_lock();
 157         *locked = false;
 158         if (atomic_read(&memcg_moving))
 159                 __mem_cgroup_begin_update_page_stat(page, locked, flags);
 160 }
 161
 162 void __mem_cgroup_end_update_page_stat(struct page *page,
 163                                 unsigned long *flags);
 164 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 165                                         bool *locked, unsigned long *flags)
 166 {
 167         if (mem_cgroup_disabled())
 168                 return;
 169         if (*locked)
 170                 __mem_cgroup_end_update_page_stat(page, flags);
 171         rcu_read_unlock();
 172 }
 173
 174 void mem_cgroup_update_page_stat(struct page *page,
 175                                  enum mem_cgroup_page_stat_item idx,
 176                                  int val);
 177
 178 static inline void mem_cgroup_inc_page_stat(struct page *page,
 179                                             enum mem_cgroup_page_stat_item idx)
 180 {
 181         mem_cgroup_update_page_stat(page, idx, 1);
 182 }
 183
 184 static inline void mem_cgroup_dec_page_stat(struct page *page,
 185                                             enum mem_cgroup_page_stat_item idx)
 186 {
 187         mem_cgroup_update_page_stat(page, idx, -1);
 188 }
 189
 190 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
 191                                                 gfp_t gfp_mask,
 192                                                 unsigned long *total_scanned);
 193 u64 mem_cgroup_get_limit(struct mem_cgroup *memcg);
 194
 195 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
 196 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 197 void mem_cgroup_split_huge_fixup(struct page *head);
 198 #endif
 199
 200 #ifdef CONFIG_DEBUG_VM
 201 bool mem_cgroup_bad_page_check(struct page *page);
 202 void mem_cgroup_print_bad_page(struct page *page);
 203 #endif
 204 #else /* CONFIG_CGROUP_MEM_RES_CTLR */
 205 struct mem_cgroup;
 206
 207 static inline int mem_cgroup_newpage_charge(struct page *page,
 208                                         struct mm_struct *mm, gfp_t gfp_mask)
 209 {
 210         return 0;
 211 }
 212
 213 static inline int mem_cgroup_cache_charge(struct page *page,
 214                                         struct mm_struct *mm, gfp_t gfp_mask)
 215 {
 216         return 0;
 217 }
 218
 219 static inline int mem_cgroup_try_charge_swapin(struct mm_struct *mm,
 220                 struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
 221 {
 222         return 0;
 223 }
 224
 225 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
 226                                           struct mem_cgroup *memcg)
 227 {
 228 }
 229
 230 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
 231 {
 232 }
 233
 234 static inline void mem_cgroup_uncharge_start(void)
 235 {
 236 }
 237
 238 static inline void mem_cgroup_uncharge_end(void)
 239 {
 240 }
 241
 242 static inline void mem_cgroup_uncharge_page(struct page *page)
 243 {
 244 }
 245
 246 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
 247 {
 248 }
 249
 250 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
 251                                                     struct mem_cgroup *memcg)
 252 {
 253         return &zone->lruvec;
 254 }
 255
 256 static inline struct lruvec *mem_cgroup_lru_add_list(struct zone *zone,
 257                                                      struct page *page,
 258                                                      enum lru_list lru)
 259 {
 260         return &zone->lruvec;
 261 }
 262
 263 static inline void mem_cgroup_lru_del_list(struct page *page, enum lru_list lru)
 264 {
 265 }
 266
 267 static inline struct lruvec *mem_cgroup_lru_move_lists(struct zone *zone,
 268                                                        struct page *page,
 269                                                        enum lru_list from,
 270                                                        enum lru_list to)
 271 {
 272         return &zone->lruvec;
 273 }
 274
 275 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
 276 {
 277         return NULL;
 278 }
 279
 280 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
 281 {
 282         return NULL;
 283 }
 284
 285 static inline int mm_match_cgroup(struct mm_struct *mm,
 286                 struct mem_cgroup *memcg)
 287 {
 288         return 1;
 289 }
 290
 291 static inline int task_in_mem_cgroup(struct task_struct *task,
 292                                      const struct mem_cgroup *memcg)
 293 {
 294         return 1;
 295 }
 296
 297 static inline struct cgroup_subsys_state
 298                 *mem_cgroup_css(struct mem_cgroup *memcg)
 299 {
 300         return NULL;
 301 }
 302
 303 static inline int
 304 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
 305         struct mem_cgroup **memcgp, gfp_t gfp_mask)
 306 {
 307         return 0;
 308 }
 309
 310 static inline void mem_cgroup_end_migration(struct mem_cgroup *memcg,
 311                 struct page *oldpage, struct page *newpage, bool migration_ok)
 312 {
 313 }
 314
 315 static inline struct mem_cgroup *
 316 mem_cgroup_iter(struct mem_cgroup *root,
 317                 struct mem_cgroup *prev,
 318                 struct mem_cgroup_reclaim_cookie *reclaim)
 319 {
 320         return NULL;
 321 }
 322
 323 static inline void mem_cgroup_iter_break(struct mem_cgroup *root,
 324                                          struct mem_cgroup *prev)
 325 {
 326 }
 327
 328 static inline bool mem_cgroup_disabled(void)
 329 {
 330         return true;
 331 }
 332
 333 static inline int
 334 mem_cgroup_inactive_anon_is_low(struct mem_cgroup *memcg, struct zone *zone)
 335 {
 336         return 1;
 337 }
 338
 339 static inline int
 340 mem_cgroup_inactive_file_is_low(struct mem_cgroup *memcg, struct zone *zone)
 341 {
 342         return 1;
 343 }
 344
 345 static inline unsigned long
 346 mem_cgroup_zone_nr_lru_pages(struct mem_cgroup *memcg, int nid, int zid,
 347                                 unsigned int lru_mask)
 348 {
 349         return 0;
 350 }
 351
 352 static inline struct zone_reclaim_stat*
 353 mem_cgroup_get_reclaim_stat_from_page(struct page *page)
 354 {
 355         return NULL;
 356 }
 357
 358 static inline void
 359 mem_cgroup_print_oom_info(struct mem_cgroup *memcg, struct task_struct *p)
 360 {
 361 }
 362
 363 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 364                                         bool *locked, unsigned long *flags)
 365 {
 366 }
 367
 368 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 369                                         bool *locked, unsigned long *flags)
 370 {
 371 }
 372
 373 static inline void mem_cgroup_inc_page_stat(struct page *page,
 374                                             enum mem_cgroup_page_stat_item idx)
 375 {
 376 }
 377
 378 static inline void mem_cgroup_dec_page_stat(struct page *page,
 379                                             enum mem_cgroup_page_stat_item idx)
 380 {
 381 }
 382
 383 static inline
 384 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
 385                                             gfp_t gfp_mask,
 386                                             unsigned long *total_scanned)
 387 {
 388         return 0;
 389 }
 390
 391 static inline
 392 u64 mem_cgroup_get_limit(struct mem_cgroup *memcg)
 393 {
 394         return 0;
 395 }
 396
 397 static inline void mem_cgroup_split_huge_fixup(struct page *head)
 398 {
 399 }
 400
 401 static inline
 402 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx)
 403 {
 404 }
 405 static inline void mem_cgroup_replace_page_cache(struct page *oldpage,
 406                                 struct page *newpage)
 407 {
 408 }
 409 #endif /* CONFIG_CGROUP_MEM_RES_CTLR */
 410
 411 #if !defined(CONFIG_CGROUP_MEM_RES_CTLR) || !defined(CONFIG_DEBUG_VM)
 412 static inline bool
 413 mem_cgroup_bad_page_check(struct page *page)
 414 {
 415         return false;
 416 }
 417
 418 static inline void
 419 mem_cgroup_print_bad_page(struct page *page)
 420 {
 421 }
 422 #endif
 423
 424 enum {
 425         UNDER_LIMIT,
 426         SOFT_LIMIT,
 427         OVER_LIMIT,
 428 };
 429
 430 struct sock;
 431 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
 432 void sock_update_memcg(struct sock *sk);
 433 void sock_release_memcg(struct sock *sk);
 434 #else
 435 static inline void sock_update_memcg(struct sock *sk)
 436 {
 437 }
 438 static inline void sock_release_memcg(struct sock *sk)
 439 {
 440 }
 441 #endif /* CONFIG_CGROUP_MEM_RES_CTLR_KMEM */
 442 #endif /* _LINUX_MEMCONTROL_H */
 443