blob: 5bc0457ee3a88955f64b750a06858d45cb74b5da [file] [log] [blame]
Alexey Dobriyan8ac773b2006-10-19 23:28:32 -07001#ifndef __INCLUDE_LINUX_OOM_H
2#define __INCLUDE_LINUX_OOM_H
3
David Rientjes5a3135c22007-10-16 23:25:53 -07004
David Rientjesa63d83f2010-08-09 17:19:46 -07005#include <linux/sched.h>
David Rientjes172acf62007-10-16 23:25:59 -07006#include <linux/types.h>
KAMEZAWA Hiroyuki4365a562009-12-15 16:45:33 -08007#include <linux/nodemask.h>
David Howells607ca462012-10-13 10:46:48 +01008#include <uapi/linux/oom.h>
David Rientjes172acf62007-10-16 23:25:59 -07009
10struct zonelist;
11struct notifier_block;
Andrew Morton74bcbf42010-08-09 17:19:43 -070012struct mem_cgroup;
13struct task_struct;
David Rientjes172acf62007-10-16 23:25:59 -070014
David Rientjes8989e4c2015-09-08 15:00:44 -070015/*
16 * Details of the page allocation that triggered the oom killer that are used to
17 * determine what should be killed.
18 */
David Rientjes6e0fc462015-09-08 15:00:36 -070019struct oom_control {
David Rientjes8989e4c2015-09-08 15:00:44 -070020 /* Used to determine cpuset */
David Rientjes6e0fc462015-09-08 15:00:36 -070021 struct zonelist *zonelist;
David Rientjes8989e4c2015-09-08 15:00:44 -070022
23 /* Used to determine mempolicy */
24 nodemask_t *nodemask;
25
Vladimir Davydov2a966b72016-07-26 15:22:33 -070026 /* Memory cgroup in which oom is invoked, or NULL for global oom */
27 struct mem_cgroup *memcg;
28
David Rientjes8989e4c2015-09-08 15:00:44 -070029 /* Used to determine cpuset and node locality requirement */
30 const gfp_t gfp_mask;
31
32 /*
33 * order == -1 means the oom kill is required by sysrq, otherwise only
34 * for display purposes.
35 */
36 const int order;
David Rientjes6e0fc462015-09-08 15:00:36 -070037};
38
David Rientjes70e24bd2007-10-16 23:25:53 -070039/*
40 * Types of limitations to the nodes from which allocations may occur
41 */
42enum oom_constraint {
43 CONSTRAINT_NONE,
44 CONSTRAINT_CPUSET,
45 CONSTRAINT_MEMORY_POLICY,
David Rientjes309ed882010-08-09 17:18:54 -070046 CONSTRAINT_MEMCG,
David Rientjes70e24bd2007-10-16 23:25:53 -070047};
48
David Rientjes9cbb78b2012-07-31 16:43:44 -070049enum oom_scan_t {
50 OOM_SCAN_OK, /* scan thread and find its badness */
51 OOM_SCAN_CONTINUE, /* do not consider thread for oom kill */
52 OOM_SCAN_ABORT, /* abort the iteration and return */
53 OOM_SCAN_SELECT, /* always select this thread first */
54};
55
Johannes Weinerdc564012015-06-24 16:57:19 -070056extern struct mutex oom_lock;
57
David Rientjese1e12d22012-12-11 16:02:56 -080058static inline void set_current_oom_origin(void)
59{
Tetsuo Handac96fc2d2016-05-23 16:23:57 -070060 current->signal->oom_flag_origin = true;
David Rientjese1e12d22012-12-11 16:02:56 -080061}
62
63static inline void clear_current_oom_origin(void)
64{
Tetsuo Handac96fc2d2016-05-23 16:23:57 -070065 current->signal->oom_flag_origin = false;
David Rientjese1e12d22012-12-11 16:02:56 -080066}
67
68static inline bool oom_task_origin(const struct task_struct *p)
69{
Tetsuo Handac96fc2d2016-05-23 16:23:57 -070070 return p->signal->oom_flag_origin;
David Rientjese1e12d22012-12-11 16:02:56 -080071}
David Rientjes72788c32011-05-24 17:11:40 -070072
Johannes Weiner16e95192015-06-24 16:57:07 -070073extern void mark_oom_victim(struct task_struct *tsk);
Michal Hocko49550b62015-02-11 15:26:12 -080074
Michal Hocko3ef22df2016-05-19 17:13:12 -070075#ifdef CONFIG_MMU
Michal Hocko1af8bb42016-07-28 15:44:52 -070076extern void wake_oom_reaper(struct task_struct *tsk);
Michal Hocko3ef22df2016-05-19 17:13:12 -070077#else
Michal Hocko1af8bb42016-07-28 15:44:52 -070078static inline void wake_oom_reaper(struct task_struct *tsk)
Michal Hocko3ef22df2016-05-19 17:13:12 -070079{
80}
81#endif
82
David Rientjesa7f638f2012-05-29 15:06:47 -070083extern unsigned long oom_badness(struct task_struct *p,
84 struct mem_cgroup *memcg, const nodemask_t *nodemask,
85 unsigned long totalpages);
Michal Hocko5695be12014-10-20 18:12:32 +020086
David Rientjes6e0fc462015-09-08 15:00:36 -070087extern void oom_kill_process(struct oom_control *oc, struct task_struct *p,
David Rientjes9cbb78b2012-07-31 16:43:44 -070088 unsigned int points, unsigned long totalpages,
Vladimir Davydov2a966b72016-07-26 15:22:33 -070089 const char *message);
David Rientjes9cbb78b2012-07-31 16:43:44 -070090
David Rientjes6e0fc462015-09-08 15:00:36 -070091extern void check_panic_on_oom(struct oom_control *oc,
Vladimir Davydov2a966b72016-07-26 15:22:33 -070092 enum oom_constraint constraint);
David Rientjes876aafb2012-07-31 16:43:48 -070093
David Rientjes6e0fc462015-09-08 15:00:36 -070094extern enum oom_scan_t oom_scan_process_thread(struct oom_control *oc,
Tetsuo Handafbe84a02016-07-26 15:24:39 -070095 struct task_struct *task);
David Rientjes9cbb78b2012-07-31 16:43:44 -070096
David Rientjes6e0fc462015-09-08 15:00:36 -070097extern bool out_of_memory(struct oom_control *oc);
Johannes Weiner16e95192015-06-24 16:57:07 -070098
Michal Hocko36324a92016-03-25 14:20:27 -070099extern void exit_oom_victim(struct task_struct *tsk);
Johannes Weiner16e95192015-06-24 16:57:07 -0700100
David Rientjes5a3135c22007-10-16 23:25:53 -0700101extern int register_oom_notifier(struct notifier_block *nb);
102extern int unregister_oom_notifier(struct notifier_block *nb);
103
Alexey Dobriyan1a8670a2009-09-21 17:03:09 -0700104extern bool oom_killer_disabled;
Michal Hockoc32b3cb2015-02-11 15:26:24 -0800105extern bool oom_killer_disable(void);
106extern void oom_killer_enable(void);
David Rientjes8e4228e2010-08-09 17:18:56 -0700107
KAMEZAWA Hiroyuki158e0a22010-08-10 18:03:00 -0700108extern struct task_struct *find_lock_task_mm(struct task_struct *p);
109
Michal Hocko1af8bb42016-07-28 15:44:52 -0700110bool task_will_free_mem(struct task_struct *task);
Oleg Nesterovd003f372014-12-12 16:56:24 -0800111
David Rientjes8e4228e2010-08-09 17:18:56 -0700112/* sysctls */
113extern int sysctl_oom_dump_tasks;
114extern int sysctl_oom_kill_allocating_task;
115extern int sysctl_panic_on_oom;
David Rientjes5a3135c22007-10-16 23:25:53 -0700116#endif /* _INCLUDE_LINUX_OOM_H */