Commit e7d952cc authored by Ingo Molnar's avatar Ingo Molnar
Browse files

perf/headers: Clean up <linux/perf_event.h> a bit 



Do a bit of readability spring cleaning:

 - Fix misaligned structure member in perf_addr_filter: the new
   struct perf_addr_filter::action member was too long, but when
   it was added it was not aligned properly. Align all fields to
   the customary column 41 alignment of most of the rest of the
   header.

 - Adjust the vertical alignment of the definition of other
   structures and definitions as well, so that the 'most of' in
   the previous paragraph changes to 'all of'. ;-)

 - Prettify the assignments in perf_clear_branch_entry_bitfields()

 - Move comments from CPP definitions to outside the macro

 - Move perf_guest_info_callbacks and related defines from the front
   of the header closer to where it's used within the header.

 - And more #endif markers for larger CPP blocks and standardize
   #if/#else/#endif blocks to the following nomenclature:

	#ifdef CONFIG_FOO
	...
	#else /* !CONFIG_FOO: */
	...
	#endif /* !CONFIG_FOO */

 - Standardize on consistently using the 'extern' storage class where
   appropriate, we had cases where method prototypes sometimes omitted
   the storage class:

	extern void perf_pmu_migrate_context(struct pmu *pmu,
					int src_cpu, int dst_cpu);
	int perf_event_read_local(struct perf_event *event, u64 *value,
				  u64 *enabled, u64 *running);
	extern u64 perf_event_read_value(struct perf_event *event,
					 u64 *enabled, u64 *running);

   Which is obviously a bit confusing and adds unnecessary noise.

 - s/__u64/u64 and similar cleanups: there's no point in using __u64
   in non-UAPI headers, and doing so only adds unnecessary visual noise.

 - Harmonize all multi-parameter function prototypes along the following
   style:

	extern struct perf_event *
	perf_event_create_kernel_counter(struct perf_event_attr *attr,
					 int cpu,
					 struct task_struct *task,
					 perf_overflow_handler_t callback,
					 void *context);
 - etc.

Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Ian Rogers <irogers@google.com>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
parent 44889ff6

include/linux/perf_event.h

+155 −127
Original line number Diff line number Diff line
@@ -26,15 +26,6 @@ 
# include <asm/local64.h>

#endif



#define PERF_GUEST_ACTIVE	0x01

#define PERF_GUEST_USER	0x02



struct perf_guest_info_callbacks {

	unsigned int			(*state)(void);

	unsigned long			(*get_ip)(void);

	unsigned int			(*handle_intel_pt_intr)(void);

};



#ifdef CONFIG_HAVE_HW_BREAKPOINT

# include <linux/rhashtable-types.h>

# include <asm/hw_breakpoint.h>
@@ -62,11 +53,12 @@ struct perf_guest_info_callbacks { 
#include <linux/security.h>

#include <linux/static_call.h>

#include <linux/lockdep.h>



#include <asm/local.h>



struct perf_callchain_entry {

	__u64				nr;

	__u64				ip[]; /* /proc/sys/kernel/perf_event_max_stack */

	u64				nr;

	u64				ip[]; /* /proc/sys/kernel/perf_event_max_stack */

};



struct perf_callchain_entry_ctx {
@@ -121,8 +113,8 @@ static __always_inline bool perf_raw_frag_last(const struct perf_raw_frag *frag) 
 * already stored in age order, the hw_idx should be 0.

 */

struct perf_branch_stack {

	__u64				nr;

	__u64				hw_idx;

	u64				nr;

	u64				hw_idx;

	struct perf_branch_entry	entries[];

};
@@ -227,8 +219,13 @@ struct hw_perf_event { 
/*

 * hw_perf_event::state flags; used to track the PERF_EF_* state.

 */

#define PERF_HES_STOPPED	0x01 /* the counter is stopped */

#define PERF_HES_UPTODATE	0x02 /* event->count up-to-date */



/* the counter is stopped */

#define PERF_HES_STOPPED		0x01



/* event->count up-to-date */

#define PERF_HES_UPTODATE		0x02



#define PERF_HES_ARCH			0x04



	int				state;
@@ -278,7 +275,7 @@ struct hw_perf_event { 
	 */

	u64				freq_time_stamp;

	u64				freq_count_stamp;

#endif

#endif /* CONFIG_PERF_EVENTS */

};



struct perf_event;
@@ -287,8 +284,12 @@ struct perf_event_pmu_context; 
/*

 * Common implementation detail of pmu::{start,commit,cancel}_txn

 */

#define PERF_PMU_TXN_ADD  0x1		/* txn to add/schedule event on PMU */

#define PERF_PMU_TXN_READ 0x2		/* txn to read event group from PMU */



/* txn to add/schedule event on PMU */

#define PERF_PMU_TXN_ADD		0x1



/* txn to read event group from PMU */

#define PERF_PMU_TXN_READ		0x2



/**

 * pmu::capabilities flags
@@ -393,11 +394,21 @@ struct pmu { 
	 * Flags for ->add()/->del()/ ->start()/->stop(). There are

	 * matching hw_perf_event::state flags.

	 */

#define PERF_EF_START	0x01		/* start the counter when adding    */

#define PERF_EF_RELOAD	0x02		/* reload the counter when starting */

#define PERF_EF_UPDATE	0x04		/* update the counter when stopping */

#define PERF_EF_PAUSE	0x08		/* AUX area event, pause tracing */

#define PERF_EF_RESUME	0x10		/* AUX area event, resume tracing */



/* start the counter when adding    */

#define PERF_EF_START			0x01



/* reload the counter when starting */

#define PERF_EF_RELOAD			0x02



/* update the counter when stopping */

#define PERF_EF_UPDATE			0x04



/* AUX area event, pause tracing */

#define PERF_EF_PAUSE			0x08



/* AUX area event, resume tracing */

#define PERF_EF_RESUME			0x10



	/*

	 * Adds/Removes a counter to/from the PMU, can be done inside a
@@ -880,7 +891,7 @@ struct perf_event { 
	 * of it. event->orig_type contains original 'type' requested by

	 * user.

	 */

	__u32				orig_type;

	u32				orig_type;

#endif /* CONFIG_PERF_EVENTS */

};
@@ -1189,15 +1200,17 @@ extern void perf_pmu_resched(struct pmu *pmu); 
extern int perf_event_refresh(struct perf_event *event, int refresh);

extern void perf_event_update_userpage(struct perf_event *event);

extern int perf_event_release_kernel(struct perf_event *event);



extern struct perf_event *

perf_event_create_kernel_counter(struct perf_event_attr *attr,

				 int cpu,

				 struct task_struct *task,

				 perf_overflow_handler_t callback,

				 void *context);



extern void perf_pmu_migrate_context(struct pmu *pmu,

				     int src_cpu, int dst_cpu);

int perf_event_read_local(struct perf_event *event, u64 *value,

extern int perf_event_read_local(struct perf_event *event, u64 *value,

				 u64 *enabled, u64 *running);

extern u64 perf_event_read_value(struct perf_event *event,

				 u64 *enabled, u64 *running);
@@ -1611,7 +1624,17 @@ extern void perf_event_bpf_event(struct bpf_prog *prog, 
				 enum perf_bpf_event_type type,

				 u16 flags);



#define PERF_GUEST_ACTIVE		0x01

#define PERF_GUEST_USER			0x02



struct perf_guest_info_callbacks {

	unsigned int			(*state)(void);

	unsigned long			(*get_ip)(void);

	unsigned int			(*handle_intel_pt_intr)(void);

};



#ifdef CONFIG_GUEST_PERF_EVENTS



extern struct perf_guest_info_callbacks __rcu *perf_guest_cbs;



DECLARE_STATIC_CALL(__perf_guest_state, *perf_guest_cbs->state);
@@ -1622,21 +1645,27 @@ static inline unsigned int perf_guest_state(void) 
{

	return static_call(__perf_guest_state)();

}



static inline unsigned long perf_guest_get_ip(void)

{

	return static_call(__perf_guest_get_ip)();

}



static inline unsigned int perf_guest_handle_intel_pt_intr(void)

{

	return static_call(__perf_guest_handle_intel_pt_intr)();

}



extern void perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *cbs);

extern void perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *cbs);

#else



#else /* !CONFIG_GUEST_PERF_EVENTS: */



static inline unsigned int perf_guest_state(void)		 { return 0; }

static inline unsigned long perf_guest_get_ip(void)		 { return 0; }

static inline unsigned int perf_guest_handle_intel_pt_intr(void) { return 0; }

#endif /* CONFIG_GUEST_PERF_EVENTS */



#endif /* !CONFIG_GUEST_PERF_EVENTS */



extern void perf_event_exec(void);

extern void perf_event_comm(struct task_struct *tsk, bool exec);
@@ -1666,6 +1695,7 @@ static inline int perf_callchain_store_context(struct perf_callchain_entry_ctx * 
{

	if (ctx->contexts < sysctl_perf_event_max_contexts_per_stack) {

		struct perf_callchain_entry *entry = ctx->entry;



		entry->ip[entry->nr++] = ip;

		++ctx->contexts;

		return 0;
@@ -1679,6 +1709,7 @@ static inline int perf_callchain_store(struct perf_callchain_entry_ctx *ctx, u64 
{

	if (ctx->nr < ctx->max_stack && !ctx->contexts_maxed) {

		struct perf_callchain_entry *entry = ctx->entry;



		entry->ip[entry->nr++] = ip;

		++ctx->nr;

		return 0;
@@ -1705,7 +1736,7 @@ static inline int perf_is_paranoid(void) 
	return sysctl_perf_event_paranoid > -1;

}



int perf_allow_kernel(void);

extern int perf_allow_kernel(void);



static inline int perf_allow_cpu(void)

{
@@ -1844,7 +1875,9 @@ extern void perf_event_task_tick(void); 
extern int perf_event_account_interrupt(struct perf_event *event);

extern int perf_event_period(struct perf_event *event, u64 value);

extern u64 perf_event_pause(struct perf_event *event, bool reset);



#else /* !CONFIG_PERF_EVENTS: */



static inline void *

perf_aux_output_begin(struct perf_output_handle *handle,

		      struct perf_event *event)				{ return NULL; }
@@ -1922,19 +1955,14 @@ static inline void perf_event_disable(struct perf_event *event) { } 
static inline int __perf_event_disable(void *info)			{ return -1; }

static inline void perf_event_task_tick(void)				{ }

static inline int perf_event_release_kernel(struct perf_event *event)	{ return 0; }

static inline int perf_event_period(struct perf_event *event, u64 value)

{

	return -EINVAL;

}

static inline u64 perf_event_pause(struct perf_event *event, bool reset)

{

	return 0;

}

static inline int perf_exclude_event(struct perf_event *event, struct pt_regs *regs)

{

	return 0;

}

#endif

static inline int

perf_event_period(struct perf_event *event, u64 value)			{ return -EINVAL; }

static inline u64

perf_event_pause(struct perf_event *event, bool reset)			{ return 0; }

static inline int

perf_exclude_event(struct perf_event *event, struct pt_regs *regs)	{ return 0; }



#endif /* !CONFIG_PERF_EVENTS */



#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_CPU_SUP_INTEL)

extern void perf_restore_debug_store(void);
@@ -2008,8 +2036,8 @@ static struct device_attribute format_attr_##_name = __ATTR_RO(_name) 


/* Performance counter hotplug functions */

#ifdef CONFIG_PERF_EVENTS

int perf_event_init_cpu(unsigned int cpu);

int perf_event_exit_cpu(unsigned int cpu);

extern int perf_event_init_cpu(unsigned int cpu);

extern int perf_event_exit_cpu(unsigned int cpu);

#else

# define perf_event_init_cpu		NULL

# define perf_event_exit_cpu		NULL