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_MEMCG
  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_page_lruvec(struct page *, struct zone *);
  67
  68 /* For coalescing uncharge for reducing memcg' overhead*/
  69 extern void mem_cgroup_uncharge_start(void);
  70 extern void mem_cgroup_uncharge_end(void);
  71
  72 extern void mem_cgroup_uncharge_page(struct page *page);
  73 extern void mem_cgroup_uncharge_cache_page(struct page *page);
  74
  75 bool __mem_cgroup_same_or_subtree(const struct mem_cgroup *root_memcg,
  76                                   struct mem_cgroup *memcg);
  77 int task_in_mem_cgroup(struct task_struct *task, const struct mem_cgroup *memcg);
  78
  79 extern struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page);
  80 extern struct mem_cgroup *mem_cgroup_from_task(struct task_struct *p);
  81 extern struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm);
  82
  83 extern struct mem_cgroup *parent_mem_cgroup(struct mem_cgroup *memcg);
  84 extern struct mem_cgroup *mem_cgroup_from_cont(struct cgroup *cont);
  85
  86 static inline
  87 int mm_match_cgroup(const struct mm_struct *mm, const struct mem_cgroup *cgroup)
  88 {
  89         struct mem_cgroup *memcg;
  90         int match;
  91
  92         rcu_read_lock();
  93         memcg = mem_cgroup_from_task(rcu_dereference((mm)->owner));
  94         match = __mem_cgroup_same_or_subtree(cgroup, memcg);
  95         rcu_read_unlock();
  96         return match;
  97 }
  98
  99 extern struct cgroup_subsys_state *mem_cgroup_css(struct mem_cgroup *memcg);
 100
 101 extern int
 102 mem_cgroup_prepare_migration(struct page *page,
 103         struct page *newpage, struct mem_cgroup **memcgp, gfp_t gfp_mask);
 104 extern void mem_cgroup_end_migration(struct mem_cgroup *memcg,
 105         struct page *oldpage, struct page *newpage, bool migration_ok);
 106
 107 struct mem_cgroup *mem_cgroup_iter(struct mem_cgroup *,
 108                                    struct mem_cgroup *,
 109                                    struct mem_cgroup_reclaim_cookie *);
 110 void mem_cgroup_iter_break(struct mem_cgroup *, struct mem_cgroup *);
 111
 112 /*
 113  * For memory reclaim.
 114  */
 115 int mem_cgroup_inactive_anon_is_low(struct lruvec *lruvec);
 116 int mem_cgroup_inactive_file_is_low(struct lruvec *lruvec);
 117 int mem_cgroup_select_victim_node(struct mem_cgroup *memcg);
 118 unsigned long mem_cgroup_get_lru_size(struct lruvec *lruvec, enum lru_list);
 119 void mem_cgroup_update_lru_size(struct lruvec *, enum lru_list, int);
 120 extern void mem_cgroup_print_oom_info(struct mem_cgroup *memcg,
 121                                         struct task_struct *p);
 122 extern void mem_cgroup_replace_page_cache(struct page *oldpage,
 123                                         struct page *newpage);
 124
 125 #ifdef CONFIG_MEMCG_SWAP
 126 extern int do_swap_account;
 127 #endif
 128
 129 static inline bool mem_cgroup_disabled(void)
 130 {
 131         if (mem_cgroup_subsys.disabled)
 132                 return true;
 133         return false;
 134 }
 135
 136 void __mem_cgroup_begin_update_page_stat(struct page *page, bool *locked,
 137                                          unsigned long *flags);
 138
 139 extern atomic_t memcg_moving;
 140
 141 static inline void mem_cgroup_begin_update_page_stat(struct page *page,
 142                                         bool *locked, unsigned long *flags)
 143 {
 144         if (mem_cgroup_disabled())
 145                 return;
 146         rcu_read_lock();
 147         *locked = false;
 148         if (atomic_read(&memcg_moving))
 149                 __mem_cgroup_begin_update_page_stat(page, locked, flags);
 150 }
 151
 152 void __mem_cgroup_end_update_page_stat(struct page *page,
 153                                 unsigned long *flags);
 154 static inline void mem_cgroup_end_update_page_stat(struct page *page,
 155                                         bool *locked, unsigned long *flags)
 156 {
 157         if (mem_cgroup_disabled())
 158                 return;
 159         if (*locked)
 160                 __mem_cgroup_end_update_page_stat(page, flags);
 161         rcu_read_unlock();
 162 }
 163
 164 void mem_cgroup_update_page_stat(struct page *page,
 165                                  enum mem_cgroup_page_stat_item idx,
 166                                  int val);
 167
 168 static inline void mem_cgroup_inc_page_stat(struct page *page,
 169                                             enum mem_cgroup_page_stat_item idx)
 170 {
 171         mem_cgroup_update_page_stat(page, idx, 1);
 172 }
 173
 174 static inline void mem_cgroup_dec_page_stat(struct page *page,
 175                                             enum mem_cgroup_page_stat_item idx)
 176 {
 177         mem_cgroup_update_page_stat(page, idx, -1);
 178 }
 179
 180 unsigned long mem_cgroup_soft_limit_reclaim(struct zone *zone, int order,
 181                                                 gfp_t gfp_mask,
 182                                                 unsigned long *total_scanned);
 183 extern void __mem_cgroup_out_of_memory(struct mem_cgroup *memcg, gfp_t gfp_mask,
 184                                        int order);
 185
 186 void mem_cgroup_count_vm_event(struct mm_struct *mm, enum vm_event_item idx);
 187 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 188 void mem_cgroup_split_huge_fixup(struct page *head);
 189 #endif
 190
 191 #ifdef CONFIG_DEBUG_VM
 192 bool mem_cgroup_bad_page_check(struct page *page);
 193 void mem_cgroup_print_bad_page(struct page *page);
 194 #endif
 195 #else /* CONFIG_MEMCG */
 196 struct mem_cgroup;
 197
 198 static inline int mem_cgroup_newpage_charge(struct page *page,
 199                                         struct mm_struct *mm, gfp_t gfp_mask)
 200 {
 201         return 0;
 202 }
 203
 204 static inline int mem_cgroup_cache_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_try_charge_swapin(struct mm_struct *mm,
 211                 struct page *page, gfp_t gfp_mask, struct mem_cgroup **memcgp)
 212 {
 213         return 0;
 214 }
 215
 216 static inline void mem_cgroup_commit_charge_swapin(struct page *page,
 217                                           struct mem_cgroup *memcg)
 218 {
 219 }
 220
 221 static inline void mem_cgroup_cancel_charge_swapin(struct mem_cgroup *memcg)
 222 {
 223 }
 224
 225 static inline void mem_cgroup_uncharge_start(void)
 226 {
 227 }
 228
 229 static inline void mem_cgroup_uncharge_end(void)
 230 {
 231 }
 232
 233 static inline void mem_cgroup_uncharge_page(struct page *page)
 234 {
 235 }
 236
 237 static inline void mem_cgroup_uncharge_cache_page(struct page *page)
 238 {
 239 }
 240
 241 static inline struct lruvec *mem_cgroup_zone_lruvec(struct zone *zone,
 242                                                     struct mem_cgroup *memcg)
 243 {
 244         return &zone->lruvec;
 245 }
 246
 247 static inline struct lruvec *mem_cgroup_page_lruvec(struct page *page,
 248                                                     struct zone *zone)
 249 {
 250         return &zone->lruvec;
 251 }
 252
 253 static inline struct mem_cgroup *try_get_mem_cgroup_from_page(struct page *page)
 254 {
 255         return NULL;
 256 }
 257
 258 static inline struct mem_cgroup *try_get_mem_cgroup_from_mm(struct mm_struct *mm)
 259 {
 260         return NULL;
 261 }
 262
 263 static inline int mm_match_cgroup(struct mm_struct *mm,
 264                 struct mem_cgroup *memcg)
 265 {
 266         return 1;
 267 }
 268
 269 static inline int task_in_mem_cgroup(struct task_struct *task,
 270                                      const struct mem_cgroup *memcg)
 271 {
 272         return 1;
 273 }
 274
 275 static inline struct cgroup_subsys_state
 276                 *mem_cgroup_css(struct mem_cgroup *memcg)
 277 {
 278         return NULL;
 279 }
 280
 281 static inline int
 282 mem_cgroup_prepare_migration(struct page *page, struct page *newpage,
 283         struct mem_cgroup **memcgp, gfp_t gfp_mask)
 284 {
 285         return 0;
 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 #ifdef 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_MEMCG_KMEM */
 413 #endif /* _LINUX_MEMCONTROL_H */
 414