[mirror_ubuntu-jammy-kernel.git] / include / linux / profile.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_PROFILE_H
#define _LINUX_PROFILE_H

#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/cpumask.h>
#include <linux/cache.h>

#include <asm/errno.h>

#define CPU_PROFILING	1
#define SCHED_PROFILING	2
#define SLEEP_PROFILING	3
#define KVM_PROFILING	4

struct proc_dir_entry;
struct notifier_block;

#if defined(CONFIG_PROFILING) && defined(CONFIG_PROC_FS)
void create_prof_cpu_mask(void);
int create_proc_profile(void);
#else
static inline void create_prof_cpu_mask(void)
{
}

static inline int create_proc_profile(void)
{
	return 0;
}
#endif

enum profile_type {
	PROFILE_TASK_EXIT,
	PROFILE_MUNMAP
};

#ifdef CONFIG_PROFILING

extern int prof_on __read_mostly;

/* init basic kernel profiler */
int profile_init(void);
int profile_setup(char *str);
void profile_tick(int type);
int setup_profiling_timer(unsigned int multiplier);

/*
 * Add multiple profiler hits to a given address:
 */
void profile_hits(int type, void *ip, unsigned int nr_hits);

/*
 * Single profiler hit:
 */
static inline void profile_hit(int type, void *ip)
{
	/*
	 * Speedup for the common (no profiling enabled) case:
	 */
	if (unlikely(prof_on == type))
		profile_hits(type, ip, 1);
}

struct task_struct;
struct mm_struct;

/* task is in do_exit() */
void profile_task_exit(struct task_struct * task);

/* task is dead, free task struct ? Returns 1 if
 * the task was taken, 0 if the task should be freed.
 */
int profile_handoff_task(struct task_struct * task);

/* sys_munmap */
void profile_munmap(unsigned long addr);

int task_handoff_register(struct notifier_block * n);
int task_handoff_unregister(struct notifier_block * n);

int profile_event_register(enum profile_type, struct notifier_block * n);
int profile_event_unregister(enum profile_type, struct notifier_block * n);

#else

#define prof_on 0

static inline int profile_init(void)
{
	return 0;
}

static inline void profile_tick(int type)
{
	return;
}

static inline void profile_hits(int type, void *ip, unsigned int nr_hits)
{
	return;
}

static inline void profile_hit(int type, void *ip)
{
	return;
}

static inline int task_handoff_register(struct notifier_block * n)
{
	return -ENOSYS;
}

static inline int task_handoff_unregister(struct notifier_block * n)
{
	return -ENOSYS;
}

static inline int profile_event_register(enum profile_type t, struct notifier_block * n)
{
	return -ENOSYS;
}

static inline int profile_event_unregister(enum profile_type t, struct notifier_block * n)
{
	return -ENOSYS;
}

#define profile_task_exit(a) do { } while (0)
#define profile_handoff_task(a) (0)
#define profile_munmap(a) do { } while (0)

#endif /* CONFIG_PROFILING */

#endif /* _LINUX_PROFILE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _LINUX_PROFILE_H
	3	#define _LINUX_PROFILE_H
	4
1da177e4	5	#include <linux/kernel.h>
1da177e4 LT	6	#include <linux/init.h>
1da177e4 LT	7	#include <linux/cpumask.h>
ece8a684 IM	8	#include <linux/cache.h>
ece8a684 IM	9
1da177e4 LT	10	#include <asm/errno.h>
	11
	12	#define CPU_PROFILING 1
	13	#define SCHED_PROFILING 2
ece8a684	14	#define SLEEP_PROFILING 3
07031e14	15	#define KVM_PROFILING 4
1da177e4 LT	16
1da177e4 LT	17	struct proc_dir_entry;
772a0dc5	18	struct notifier_block;
1da177e4	19
b03f6489	20	#if defined(CONFIG_PROFILING) && defined(CONFIG_PROC_FS)
fbd387ae	21	void create_prof_cpu_mask(void);
66f50ee3	22	int create_proc_profile(void);
b03f6489	23	#else
fbd387ae	24	static inline void create_prof_cpu_mask(void)
cebbd3fb AM	25	{
cebbd3fb AM	26	}
66f50ee3 PM	27
	28	static inline int create_proc_profile(void)
	29	{
	30	return 0;
	31	}
b03f6489 AB	32	#endif
	33
	34	enum profile_type {
	35	PROFILE_TASK_EXIT,
	36	PROFILE_MUNMAP
	37	};
	38
	39	#ifdef CONFIG_PROFILING
	40
	41	extern int prof_on __read_mostly;
	42
1da177e4	43	/* init basic kernel profiler */
22b8ce94 DH	44	int profile_init(void);
22b8ce94 DH	45	int profile_setup(char *str);
b03f6489	46	void profile_tick(int type);
d3091298	47	int setup_profiling_timer(unsigned int multiplier);
ece8a684 IM	48
	49	/*
	50	* Add multiple profiler hits to a given address:
	51	*/
b03f6489	52	void profile_hits(int type, void *ip, unsigned int nr_hits);
ece8a684 IM	53
	54	/*
	55	* Single profiler hit:
	56	*/
	57	static inline void profile_hit(int type, void *ip)
	58	{
	59	/*
	60	* Speedup for the common (no profiling enabled) case:
	61	*/
	62	if (unlikely(prof_on == type))
	63	profile_hits(type, ip, 1);
	64	}
	65
1da177e4 LT	66	struct task_struct;
	67	struct mm_struct;
	68
	69	/* task is in do_exit() */
	70	void profile_task_exit(struct task_struct * task);
	71
	72	/* task is dead, free task struct ? Returns 1 if
	73	* the task was taken, 0 if the task should be freed.
	74	*/
	75	int profile_handoff_task(struct task_struct * task);
	76
	77	/* sys_munmap */
	78	void profile_munmap(unsigned long addr);
	79
	80	int task_handoff_register(struct notifier_block * n);
	81	int task_handoff_unregister(struct notifier_block * n);
	82
	83	int profile_event_register(enum profile_type, struct notifier_block * n);
	84	int profile_event_unregister(enum profile_type, struct notifier_block * n);
	85
1da177e4 LT	86	#else
1da177e4 LT	87
b03f6489 AB	88	#define prof_on 0
b03f6489 AB	89
22b8ce94	90	static inline int profile_init(void)
b03f6489	91	{
22b8ce94	92	return 0;
b03f6489 AB	93	}
	94
	95	static inline void profile_tick(int type)
	96	{
	97	return;
	98	}
	99
	100	static inline void profile_hits(int type, void *ip, unsigned int nr_hits)
	101	{
	102	return;
	103	}
	104
	105	static inline void profile_hit(int type, void *ip)
	106	{
	107	return;
	108	}
	109
1da177e4 LT	110	static inline int task_handoff_register(struct notifier_block * n)
	111	{
	112	return -ENOSYS;
	113	}
	114
	115	static inline int task_handoff_unregister(struct notifier_block * n)
	116	{
	117	return -ENOSYS;
	118	}
	119
	120	static inline int profile_event_register(enum profile_type t, struct notifier_block * n)
	121	{
	122	return -ENOSYS;
	123	}
	124
	125	static inline int profile_event_unregister(enum profile_type t, struct notifier_block * n)
	126	{
	127	return -ENOSYS;
	128	}
	129
	130	#define profile_task_exit(a) do { } while (0)
	131	#define profile_handoff_task(a) (0)
	132	#define profile_munmap(a) do { } while (0)
	133
1da177e4 LT	134	#endif /* CONFIG_PROFILING */
1da177e4 LT	135
1da177e4	136	#endif /* _LINUX_PROFILE_H */