blob: 628a43242a343af5a3aab7779accd8ec32ad9406 [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
26 /* Used to determine cpuset and node locality requirement */
27 const gfp_t gfp_mask;
28
29 /*
30 * order == -1 means the oom kill is required by sysrq, otherwise only
31 * for display purposes.
32 */
33 const int order;
David Rientjes6e0fc462015-09-08 15:00:36 -070034};
35
David Rientjes70e24bd2007-10-16 23:25:53 -070036/*
37 * Types of limitations to the nodes from which allocations may occur
38 */
39enum oom_constraint {
40 CONSTRAINT_NONE,
41 CONSTRAINT_CPUSET,
42 CONSTRAINT_MEMORY_POLICY,
David Rientjes309ed882010-08-09 17:18:54 -070043 CONSTRAINT_MEMCG,
David Rientjes70e24bd2007-10-16 23:25:53 -070044};
45
David Rientjes9cbb78b2012-07-31 16:43:44 -070046enum oom_scan_t {
47 OOM_SCAN_OK, /* scan thread and find its badness */
48 OOM_SCAN_CONTINUE, /* do not consider thread for oom kill */
49 OOM_SCAN_ABORT, /* abort the iteration and return */
50 OOM_SCAN_SELECT, /* always select this thread first */
51};
52
David Rientjese1e12d22012-12-11 16:02:56 -080053/* Thread is the potential origin of an oom condition; kill first on oom */
54#define OOM_FLAG_ORIGIN ((__force oom_flags_t)0x1)
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{
60 current->signal->oom_flags |= OOM_FLAG_ORIGIN;
61}
62
63static inline void clear_current_oom_origin(void)
64{
65 current->signal->oom_flags &= ~OOM_FLAG_ORIGIN;
66}
67
68static inline bool oom_task_origin(const struct task_struct *p)
69{
70 return !!(p->signal->oom_flags & OOM_FLAG_ORIGIN);
71}
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
David Rientjesa7f638f2012-05-29 15:06:47 -070075extern unsigned long oom_badness(struct task_struct *p,
76 struct mem_cgroup *memcg, const nodemask_t *nodemask,
77 unsigned long totalpages);
Michal Hocko5695be12014-10-20 18:12:32 +020078
David Rientjes6e0fc462015-09-08 15:00:36 -070079extern void oom_kill_process(struct oom_control *oc, struct task_struct *p,
David Rientjes9cbb78b2012-07-31 16:43:44 -070080 unsigned int points, unsigned long totalpages,
David Rientjes6e0fc462015-09-08 15:00:36 -070081 struct mem_cgroup *memcg, const char *message);
David Rientjes9cbb78b2012-07-31 16:43:44 -070082
David Rientjes6e0fc462015-09-08 15:00:36 -070083extern void check_panic_on_oom(struct oom_control *oc,
84 enum oom_constraint constraint,
Balasubramani Vivekanandan2415b9f2015-04-14 15:48:18 -070085 struct mem_cgroup *memcg);
David Rientjes876aafb2012-07-31 16:43:48 -070086
David Rientjes6e0fc462015-09-08 15:00:36 -070087extern enum oom_scan_t oom_scan_process_thread(struct oom_control *oc,
88 struct task_struct *task, unsigned long totalpages);
David Rientjes9cbb78b2012-07-31 16:43:44 -070089
David Rientjes6e0fc462015-09-08 15:00:36 -070090extern bool out_of_memory(struct oom_control *oc);
Johannes Weiner16e95192015-06-24 16:57:07 -070091
Michal Hocko36324a92016-03-25 14:20:27 -070092extern void exit_oom_victim(struct task_struct *tsk);
Johannes Weiner16e95192015-06-24 16:57:07 -070093
David Rientjes5a3135c22007-10-16 23:25:53 -070094extern int register_oom_notifier(struct notifier_block *nb);
95extern int unregister_oom_notifier(struct notifier_block *nb);
96
Alexey Dobriyan1a8670a2009-09-21 17:03:09 -070097extern bool oom_killer_disabled;
Michal Hockoc32b3cb2015-02-11 15:26:24 -080098extern bool oom_killer_disable(void);
99extern void oom_killer_enable(void);
David Rientjes8e4228e2010-08-09 17:18:56 -0700100
KAMEZAWA Hiroyuki158e0a22010-08-10 18:03:00 -0700101extern struct task_struct *find_lock_task_mm(struct task_struct *p);
102
Oleg Nesterovd003f372014-12-12 16:56:24 -0800103static inline bool task_will_free_mem(struct task_struct *task)
104{
105 /*
106 * A coredumping process may sleep for an extended period in exit_mm(),
107 * so the oom killer cannot assume that the process will promptly exit
108 * and release memory.
109 */
110 return (task->flags & PF_EXITING) &&
111 !(task->signal->flags & SIGNAL_GROUP_COREDUMP);
112}
113
David Rientjes8e4228e2010-08-09 17:18:56 -0700114/* sysctls */
115extern int sysctl_oom_dump_tasks;
116extern int sysctl_oom_kill_allocating_task;
117extern int sysctl_panic_on_oom;
David Rientjes5a3135c22007-10-16 23:25:53 -0700118#endif /* _INCLUDE_LINUX_OOM_H */