cregit-Linux how code gets into the kernel

Release 4.12 include/linux/oprofile.h

Directory: include/linux
 * @file oprofile.h
 * API for machine-specific interrupts to interface
 * to oprofile.
 * @remark Copyright 2002 OProfile authors
 * @remark Read the file COPYING
 * @author John Levon <>

#ifndef OPROFILE_H

#define OPROFILE_H

#include <linux/types.h>
#include <linux/spinlock.h>
#include <linux/init.h>
#include <linux/errno.h>
#include <linux/printk.h>
#include <linux/atomic.h>
/* Each escaped entry is prefixed by ESCAPE_CODE
 * then one of the following codes, then the
 * relevant data.
 * These #defines live in this file so that arch-specific
 * buffer sync'ing code can access them.

#define ESCAPE_CODE			~0UL

#define CTX_SWITCH_CODE			1

#define CPU_SWITCH_CODE			2





#define CTX_TGID_CODE			7


#define TRACE_END_CODE			9




#define IBS_FETCH_CODE			13

#define IBS_OP_CODE			14

struct dentry;
struct file_operations;
struct pt_regs;
/* Operations structure to be filled in */

struct oprofile_operations {
	/* create any necessary configuration files in the oprofile fs.
         * Optional. */
int (*create_files)(struct dentry * root);
	/* Do any necessary interrupt setup. Optional. */
int (*setup)(void);
	/* Do any necessary interrupt shutdown. Optional. */
void (*shutdown)(void);
	/* Start delivering interrupts. */
int (*start)(void);
	/* Stop delivering interrupts. */
void (*stop)(void);
	/* Arch-specific buffer sync functions.
         * Return value = 0:  Success
         * Return value = -1: Failure
         * Return value = 1:  Run generic sync function
int (*sync_start)(void);
int (*sync_stop)(void);

	/* Initiate a stack backtrace. Optional. */
void (*backtrace)(struct pt_regs * const regs, unsigned int depth);

	/* Multiplex between different events. Optional. */
int (*switch_events)(void);
	/* CPU identification string. */
char * cpu_type;

 * One-time initialisation. *ops must be set to a filled-in
 * operations structure. This is called even in timer interrupt
 * mode so an arch can set a backtrace callback.
 * If an error occurs, the fields should be left untouched.
int oprofile_arch_init(struct oprofile_operations * ops);
 * One-time exit/cleanup for the arch.
void oprofile_arch_exit(void);

 * Add a sample. This may be called from any context.
void oprofile_add_sample(struct pt_regs * const regs, unsigned long event);

 * Add an extended sample.  Use this when the PC is not from the regs, and
 * we cannot determine if we're in kernel mode from the regs.
 * This function does perform a backtrace.
void oprofile_add_ext_sample(unsigned long pc, struct pt_regs * const regs,
				unsigned long event, int is_kernel);

 * Add an hardware sample.
void oprofile_add_ext_hw_sample(unsigned long pc, struct pt_regs * const regs,
	unsigned long event, int is_kernel,
	struct task_struct *task);

/* Use this instead when the PC value is not from the regs. Doesn't
 * backtrace. */
void oprofile_add_pc(unsigned long pc, int is_kernel, unsigned long event);

/* add a backtrace entry, to be called from the ->backtrace callback */
void oprofile_add_trace(unsigned long eip);

 * Create a file of the given name as a child of the given root, with
 * the specified file operations.
int oprofilefs_create_file(struct dentry * root,
	char const * name, const struct file_operations * fops);

int oprofilefs_create_file_perm(struct dentry * root,
	char const * name, const struct file_operations * fops, int perm);
/** Create a file for read/write access to an unsigned long. */
int oprofilefs_create_ulong(struct dentry * root,
	char const * name, ulong * val);
/** Create a file for read-only access to an unsigned long. */
int oprofilefs_create_ro_ulong(struct dentry * root,
	char const * name, ulong * val);
/** Create a file for read-only access to an atomic_t. */
int oprofilefs_create_ro_atomic(struct dentry * root,
	char const * name, atomic_t * val);
/** create a directory */
struct dentry *oprofilefs_mkdir(struct dentry *parent, char const *name);

 * Write the given asciz string to the given user buffer @buf, updating *offset
 * appropriately. Returns bytes written or -EFAULT.
ssize_t oprofilefs_str_to_user(char const * str, char __user * buf, size_t count, loff_t * offset);

 * Convert an unsigned long value into ASCII and copy it to the user buffer @buf,
 * updating *offset appropriately. Returns bytes written or -EFAULT.
ssize_t oprofilefs_ulong_to_user(unsigned long val, char __user * buf, size_t count, loff_t * offset);

 * Read an ASCII string for a number from a userspace buffer and fill *val on success.
 * Returns 0 on success, < 0 on error.
int oprofilefs_ulong_from_user(unsigned long * val, char const __user * buf, size_t count);

/** lock for read/write safety */
extern raw_spinlock_t oprofilefs_lock;

 * Add the contents of a circular buffer to the event buffer.
void oprofile_put_buff(unsigned long *buf, unsigned int start,
			unsigned int stop, unsigned int max);

unsigned long oprofile_get_cpu_buffer_size(void);
void oprofile_cpu_buffer_inc_smpl_lost(void);
/* cpu buffer functions */

struct op_sample;

struct op_entry {
struct ring_buffer_event *event;
struct op_sample *sample;
unsigned long size;
unsigned long *data;

void oprofile_write_reserve(struct op_entry *entry,
			    struct pt_regs * const regs,
			    unsigned long pc, int code, int size);
int oprofile_add_data(struct op_entry *entry, unsigned long val);
int oprofile_add_data64(struct op_entry *entry, u64 val);
int oprofile_write_commit(struct op_entry *entry);

int __init oprofile_perf_init(struct oprofile_operations *ops);
void oprofile_perf_exit(void);
char *op_name_from_perf_id(void);

static inline int __init oprofile_perf_init(struct oprofile_operations *ops) { pr_info("oprofile: hardware counters not available\n"); return -ENODEV; }


Ari Kauppi22100.00%1100.00%

static inline void oprofile_perf_exit(void) { }


Ari Kauppi8100.00%1100.00%

#endif /* CONFIG_HW_PERF_EVENTS */ #endif /* OPROFILE_H */

Overall Contributors

John Levon27339.97%519.23%
Robert Richter9614.06%415.38%
Bob Nelson7210.54%13.85%
Greg Banks476.88%13.85%
Ari Kauppi405.86%27.69%
Carl E. Love355.12%13.85%
Matt Fleming304.39%27.69%
Heinz Graalfs273.95%13.85%
Andrew Morton223.22%13.85%
Brian Rogan223.22%13.85%
Jason Yeh101.46%13.85%
Al Viro40.59%27.69%
Arjan van de Ven20.29%13.85%
Thomas Gleixner10.15%13.85%
Arun Sharma10.15%13.85%
Akinobu Mita10.15%13.85%
Directory: include/linux
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.