[mirror_ubuntu-zesty-kernel.git] / include / linux / oom.h

#ifndef __INCLUDE_LINUX_OOM_H
#define __INCLUDE_LINUX_OOM_H


#include <linux/sched.h>
#include <linux/types.h>
#include <linux/nodemask.h>
#include <uapi/linux/oom.h>

struct zonelist;
struct notifier_block;
struct mem_cgroup;
struct task_struct;

/*
 * Types of limitations to the nodes from which allocations may occur
 */
enum oom_constraint {
	CONSTRAINT_NONE,
	CONSTRAINT_CPUSET,
	CONSTRAINT_MEMORY_POLICY,
	CONSTRAINT_MEMCG,
};

enum oom_scan_t {
	OOM_SCAN_OK,		/* scan thread and find its badness */
	OOM_SCAN_CONTINUE,	/* do not consider thread for oom kill */
	OOM_SCAN_ABORT,		/* abort the iteration and return */
	OOM_SCAN_SELECT,	/* always select this thread first */
};

/* Thread is the potential origin of an oom condition; kill first on oom */
#define OOM_FLAG_ORIGIN		((__force oom_flags_t)0x1)

static inline void set_current_oom_origin(void)
{
	current->signal->oom_flags |= OOM_FLAG_ORIGIN;
}

static inline void clear_current_oom_origin(void)
{
	current->signal->oom_flags &= ~OOM_FLAG_ORIGIN;
}

static inline bool oom_task_origin(const struct task_struct *p)
{
	return !!(p->signal->oom_flags & OOM_FLAG_ORIGIN);
}

extern void mark_tsk_oom_victim(struct task_struct *tsk);

extern void unmark_oom_victim(void);

extern unsigned long oom_badness(struct task_struct *p,
		struct mem_cgroup *memcg, const nodemask_t *nodemask,
		unsigned long totalpages);

extern int oom_kills_count(void);
extern void note_oom_kill(void);
extern void oom_kill_process(struct task_struct *p, gfp_t gfp_mask, int order,
			     unsigned int points, unsigned long totalpages,
			     struct mem_cgroup *memcg, nodemask_t *nodemask,
			     const char *message);

extern bool oom_zonelist_trylock(struct zonelist *zonelist, gfp_t gfp_flags);
extern void oom_zonelist_unlock(struct zonelist *zonelist, gfp_t gfp_flags);

extern void check_panic_on_oom(enum oom_constraint constraint, gfp_t gfp_mask,
			       int order, const nodemask_t *nodemask,
			       struct mem_cgroup *memcg);

extern enum oom_scan_t oom_scan_process_thread(struct task_struct *task,
		unsigned long totalpages, const nodemask_t *nodemask,
		bool force_kill);

extern bool out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask,
		int order, nodemask_t *mask, bool force_kill);
extern int register_oom_notifier(struct notifier_block *nb);
extern int unregister_oom_notifier(struct notifier_block *nb);

extern bool oom_killer_disabled;
extern bool oom_killer_disable(void);
extern void oom_killer_enable(void);

extern struct task_struct *find_lock_task_mm(struct task_struct *p);

static inline bool task_will_free_mem(struct task_struct *task)
{
	/*
	 * A coredumping process may sleep for an extended period in exit_mm(),
	 * so the oom killer cannot assume that the process will promptly exit
	 * and release memory.
	 */
	return (task->flags & PF_EXITING) &&
		!(task->signal->flags & SIGNAL_GROUP_COREDUMP);
}

/* sysctls */
extern int sysctl_oom_dump_tasks;
extern int sysctl_oom_kill_allocating_task;
extern int sysctl_panic_on_oom;
#endif /* _INCLUDE_LINUX_OOM_H */
Commit	Line	Data
8ac773b4 AD	1	#ifndef __INCLUDE_LINUX_OOM_H
	2	#define __INCLUDE_LINUX_OOM_H
	3
5a3135c2	4
a63d83f4	5	#include <linux/sched.h>
172acf60	6	#include <linux/types.h>
4365a567	7	#include <linux/nodemask.h>
607ca46e	8	#include <uapi/linux/oom.h>
172acf60 DR	9
	10	struct zonelist;
	11	struct notifier_block;
74bcbf40 AM	12	struct mem_cgroup;
74bcbf40 AM	13	struct task_struct;
172acf60	14
70e24bdf DR	15	/*
	16	* Types of limitations to the nodes from which allocations may occur
	17	*/
	18	enum oom_constraint {
	19	CONSTRAINT_NONE,
	20	CONSTRAINT_CPUSET,
	21	CONSTRAINT_MEMORY_POLICY,
309ed882	22	CONSTRAINT_MEMCG,
70e24bdf DR	23	};
70e24bdf DR	24
9cbb78bb DR	25	enum oom_scan_t {
	26	OOM_SCAN_OK, /* scan thread and find its badness */
	27	OOM_SCAN_CONTINUE, /* do not consider thread for oom kill */
	28	OOM_SCAN_ABORT, /* abort the iteration and return */
	29	OOM_SCAN_SELECT, /* always select this thread first */
	30	};
	31
e1e12d2f DR	32	/* Thread is the potential origin of an oom condition; kill first on oom */
	33	#define OOM_FLAG_ORIGIN ((__force oom_flags_t)0x1)
	34
	35	static inline void set_current_oom_origin(void)
	36	{
	37	current->signal->oom_flags \|= OOM_FLAG_ORIGIN;
	38	}
	39
	40	static inline void clear_current_oom_origin(void)
	41	{
	42	current->signal->oom_flags &= ~OOM_FLAG_ORIGIN;
	43	}
	44
	45	static inline bool oom_task_origin(const struct task_struct *p)
	46	{
	47	return !!(p->signal->oom_flags & OOM_FLAG_ORIGIN);
	48	}
72788c38	49
49550b60 MH	50	extern void mark_tsk_oom_victim(struct task_struct *tsk);
	51
	52	extern void unmark_oom_victim(void);
	53
a7f638f9 DR	54	extern unsigned long oom_badness(struct task_struct *p,
	55	struct mem_cgroup memcg, const nodemask_t nodemask,
	56	unsigned long totalpages);
5695be14 MH	57
	58	extern int oom_kills_count(void);
	59	extern void note_oom_kill(void);
9cbb78bb DR	60	extern void oom_kill_process(struct task_struct *p, gfp_t gfp_mask, int order,
	61	unsigned int points, unsigned long totalpages,
	62	struct mem_cgroup memcg, nodemask_t nodemask,
	63	const char *message);
	64
e972a070 DR	65	extern bool oom_zonelist_trylock(struct zonelist *zonelist, gfp_t gfp_flags);
e972a070 DR	66	extern void oom_zonelist_unlock(struct zonelist *zonelist, gfp_t gfp_flags);
098d7f12	67
876aafbf	68	extern void check_panic_on_oom(enum oom_constraint constraint, gfp_t gfp_mask,
2415b9f5 BV	69	int order, const nodemask_t *nodemask,
2415b9f5 BV	70	struct mem_cgroup *memcg);
876aafbf	71
9cbb78bb DR	72	extern enum oom_scan_t oom_scan_process_thread(struct task_struct *task,
	73	unsigned long totalpages, const nodemask_t *nodemask,
	74	bool force_kill);
9cbb78bb	75
c32b3cbe	76	extern bool out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask,
08ab9b10	77	int order, nodemask_t *mask, bool force_kill);
5a3135c2 DR	78	extern int register_oom_notifier(struct notifier_block *nb);
	79	extern int unregister_oom_notifier(struct notifier_block *nb);
	80
1a8670a2	81	extern bool oom_killer_disabled;
c32b3cbe MH	82	extern bool oom_killer_disable(void);
c32b3cbe MH	83	extern void oom_killer_enable(void);
8e4228e1	84
158e0a2d KH	85	extern struct task_struct find_lock_task_mm(struct task_struct p);
158e0a2d KH	86
d003f371 ON	87	static inline bool task_will_free_mem(struct task_struct *task)
	88	{
	89	/*
	90	* A coredumping process may sleep for an extended period in exit_mm(),
	91	* so the oom killer cannot assume that the process will promptly exit
	92	* and release memory.
	93	*/
	94	return (task->flags & PF_EXITING) &&
	95	!(task->signal->flags & SIGNAL_GROUP_COREDUMP);
	96	}
	97
8e4228e1 DR	98	/* sysctls */
	99	extern int sysctl_oom_dump_tasks;
	100	extern int sysctl_oom_kill_allocating_task;
	101	extern int sysctl_panic_on_oom;
5a3135c2	102	#endif /* _INCLUDE_LINUX_OOM_H */