blob: 76aac4ce39bcf59e2e5eeb38053cf05f0c9d05ae [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
Ingo Molnar3f07c012017-02-08 18:51:30 +01005#include <linux/sched/signal.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>
Michal Hocko6b31d592017-08-18 15:16:15 -07009#include <linux/sched/coredump.h> /* MMF_* */
10#include <linux/mm.h> /* VM_FAULT* */
David Rientjes172acf62007-10-16 23:25:59 -070011
12struct zonelist;
13struct notifier_block;
Andrew Morton74bcbf42010-08-09 17:19:43 -070014struct mem_cgroup;
15struct task_struct;
David Rientjes172acf62007-10-16 23:25:59 -070016
David Rientjes8989e4c2015-09-08 15:00:44 -070017/*
18 * Details of the page allocation that triggered the oom killer that are used to
19 * determine what should be killed.
20 */
David Rientjes6e0fc462015-09-08 15:00:36 -070021struct oom_control {
David Rientjes8989e4c2015-09-08 15:00:44 -070022 /* Used to determine cpuset */
David Rientjes6e0fc462015-09-08 15:00:36 -070023 struct zonelist *zonelist;
David Rientjes8989e4c2015-09-08 15:00:44 -070024
25 /* Used to determine mempolicy */
26 nodemask_t *nodemask;
27
Vladimir Davydov2a966b72016-07-26 15:22:33 -070028 /* Memory cgroup in which oom is invoked, or NULL for global oom */
29 struct mem_cgroup *memcg;
30
David Rientjes8989e4c2015-09-08 15:00:44 -070031 /* Used to determine cpuset and node locality requirement */
32 const gfp_t gfp_mask;
33
34 /*
35 * order == -1 means the oom kill is required by sysrq, otherwise only
36 * for display purposes.
37 */
38 const int order;
David Rientjes6e0fc462015-09-08 15:00:36 -070039
Vladimir Davydov7c5f64f2016-10-07 16:57:23 -070040 /* Used by oom implementation, do not set */
41 unsigned long totalpages;
42 struct task_struct *chosen;
43 unsigned long chosen_points;
David Rientjes9cbb78b2012-07-31 16:43:44 -070044};
45
Johannes Weinerdc564012015-06-24 16:57:19 -070046extern struct mutex oom_lock;
47
David Rientjese1e12d22012-12-11 16:02:56 -080048static inline void set_current_oom_origin(void)
49{
Tetsuo Handac96fc2d2016-05-23 16:23:57 -070050 current->signal->oom_flag_origin = true;
David Rientjese1e12d22012-12-11 16:02:56 -080051}
52
53static inline void clear_current_oom_origin(void)
54{
Tetsuo Handac96fc2d2016-05-23 16:23:57 -070055 current->signal->oom_flag_origin = false;
David Rientjese1e12d22012-12-11 16:02:56 -080056}
57
58static inline bool oom_task_origin(const struct task_struct *p)
59{
Tetsuo Handac96fc2d2016-05-23 16:23:57 -070060 return p->signal->oom_flag_origin;
David Rientjese1e12d22012-12-11 16:02:56 -080061}
David Rientjes72788c32011-05-24 17:11:40 -070062
Michal Hocko862e3072016-10-07 16:58:57 -070063static inline bool tsk_is_oom_victim(struct task_struct * tsk)
64{
65 return tsk->signal->oom_mm;
66}
67
Michal Hocko6b31d592017-08-18 15:16:15 -070068/*
69 * Checks whether a page fault on the given mm is still reliable.
70 * This is no longer true if the oom reaper started to reap the
71 * address space which is reflected by MMF_UNSTABLE flag set in
72 * the mm. At that moment any !shared mapping would lose the content
73 * and could cause a memory corruption (zero pages instead of the
74 * original content).
75 *
76 * User should call this before establishing a page table entry for
77 * a !shared mapping and under the proper page table lock.
78 *
79 * Return 0 when the PF is safe VM_FAULT_SIGBUS otherwise.
80 */
81static inline int check_stable_address_space(struct mm_struct *mm)
82{
83 if (unlikely(test_bit(MMF_UNSTABLE, &mm->flags)))
84 return VM_FAULT_SIGBUS;
85 return 0;
86}
87
David Rientjesa7f638f2012-05-29 15:06:47 -070088extern unsigned long oom_badness(struct task_struct *p,
89 struct mem_cgroup *memcg, const nodemask_t *nodemask,
90 unsigned long totalpages);
Michal Hocko5695be12014-10-20 18:12:32 +020091
David Rientjes6e0fc462015-09-08 15:00:36 -070092extern bool out_of_memory(struct oom_control *oc);
Johannes Weiner16e95192015-06-24 16:57:07 -070093
Tetsuo Handa38531202016-10-07 16:59:03 -070094extern void exit_oom_victim(void);
Johannes Weiner16e95192015-06-24 16:57:07 -070095
David Rientjes5a3135c22007-10-16 23:25:53 -070096extern int register_oom_notifier(struct notifier_block *nb);
97extern int unregister_oom_notifier(struct notifier_block *nb);
98
Michal Hocko7d2e7a22016-10-07 16:59:00 -070099extern bool oom_killer_disable(signed long timeout);
Michal Hockoc32b3cb2015-02-11 15:26:24 -0800100extern void oom_killer_enable(void);
David Rientjes8e4228e2010-08-09 17:18:56 -0700101
KAMEZAWA Hiroyuki158e0a22010-08-10 18:03:00 -0700102extern struct task_struct *find_lock_task_mm(struct task_struct *p);
103
David Rientjes8e4228e2010-08-09 17:18:56 -0700104/* sysctls */
105extern int sysctl_oom_dump_tasks;
106extern int sysctl_oom_kill_allocating_task;
107extern int sysctl_panic_on_oom;
David Rientjes5a3135c22007-10-16 23:25:53 -0700108#endif /* _INCLUDE_LINUX_OOM_H */