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