[mirror_ubuntu-bionic-kernel.git] / arch / powerpc / oprofile / cell / pr_util.h

 /*
 * Cell Broadband Engine OProfile Support
 *
 * (C) Copyright IBM Corporation 2006
 *
 * Author: Maynard Johnson <maynardj@us.ibm.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#ifndef PR_UTIL_H
#define PR_UTIL_H

#include <linux/cpumask.h>
#include <linux/oprofile.h>
#include <asm/cell-pmu.h>
#include <asm/cell-regs.h>
#include <asm/spu.h>

/* Defines used for sync_start */
#define SKIP_GENERIC_SYNC 0
#define SYNC_START_ERROR -1
#define DO_GENERIC_SYNC 1
#define SPUS_PER_NODE   8
#define DEFAULT_TIMER_EXPIRE  (HZ / 10)

extern struct delayed_work spu_work;
extern int spu_prof_running;

struct spu_overlay_info {	/* map of sections within an SPU overlay */
	unsigned int vma;	/* SPU virtual memory address from elf */
	unsigned int size;	/* size of section from elf */
	unsigned int offset;	/* offset of section into elf file */
	unsigned int buf;
};

struct vma_to_fileoffset_map {	/* map of sections within an SPU program */
	struct vma_to_fileoffset_map *next;	/* list pointer */
	unsigned int vma;	/* SPU virtual memory address from elf */
	unsigned int size;	/* size of section from elf */
	unsigned int offset;	/* offset of section into elf file */
	unsigned int guard_ptr;
	unsigned int guard_val;
        /*
	 * The guard pointer is an entry in the _ovly_buf_table,
	 * computed using ovly.buf as the index into the table.  Since
	 * ovly.buf values begin at '1' to reference the first (or 0th)
	 * entry in the _ovly_buf_table, the computation subtracts 1
	 * from ovly.buf.
	 * The guard value is stored in the _ovly_buf_table entry and
	 * is an index (starting at 1) back to the _ovly_table entry
	 * that is pointing at this _ovly_buf_table entry.  So, for
	 * example, for an overlay scenario with one overlay segment
	 * and two overlay sections:
	 *      - Section 1 points to the first entry of the
	 *        _ovly_buf_table, which contains a guard value
	 *        of '1', referencing the first (index=0) entry of
	 *        _ovly_table.
	 *      - Section 2 points to the second entry of the
	 *        _ovly_buf_table, which contains a guard value
	 *        of '2', referencing the second (index=1) entry of
	 *        _ovly_table.
	 */

};

struct spu_buffer {
	int last_guard_val;
	int ctx_sw_seen;
	unsigned long *buff;
	unsigned int head, tail;
};


/* The three functions below are for maintaining and accessing
 * the vma-to-fileoffset map.
 */
struct vma_to_fileoffset_map *create_vma_map(const struct spu *spu,
					     u64 objectid);
unsigned int vma_map_lookup(struct vma_to_fileoffset_map *map,
			    unsigned int vma, const struct spu *aSpu,
			    int *grd_val);
void vma_map_free(struct vma_to_fileoffset_map *map);

/*
 * Entry point for SPU profiling.
 * cycles_reset is the SPU_CYCLES count value specified by the user.
 */
int start_spu_profiling(unsigned int cycles_reset);

void stop_spu_profiling(void);


/* add the necessary profiling hooks */
int spu_sync_start(void);

/* remove the hooks */
int spu_sync_stop(void);

/* Record SPU program counter samples to the oprofile event buffer. */
void spu_sync_buffer(int spu_num, unsigned int *samples,
		     int num_samples);

void set_spu_profiling_frequency(unsigned int freq_khz, unsigned int cycles_reset);

#endif	  /* PR_UTIL_H */
Commit	Line	Data
1474855d BN	1	/*
	2	* Cell Broadband Engine OProfile Support
	3	*
	4	* (C) Copyright IBM Corporation 2006
	5	*
	6	* Author: Maynard Johnson <maynardj@us.ibm.com>
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License
	10	* as published by the Free Software Foundation; either version
	11	* 2 of the License, or (at your option) any later version.
	12	*/
	13
	14	#ifndef PR_UTIL_H
	15	#define PR_UTIL_H
	16
	17	#include <linux/cpumask.h>
	18	#include <linux/oprofile.h>
	19	#include <asm/cell-pmu.h>
eef686a0	20	#include <asm/cell-regs.h>
1474855d BN	21	#include <asm/spu.h>
1474855d BN	22
1474855d BN	23	/* Defines used for sync_start */
	24	#define SKIP_GENERIC_SYNC 0
	25	#define SYNC_START_ERROR -1
	26	#define DO_GENERIC_SYNC 1
a5598ca0 CL	27	#define SPUS_PER_NODE 8
	28	#define DEFAULT_TIMER_EXPIRE (HZ / 10)
	29
	30	extern struct delayed_work spu_work;
	31	extern int spu_prof_running;
1474855d BN	32
	33	struct spu_overlay_info { /* map of sections within an SPU overlay */
	34	unsigned int vma; /* SPU virtual memory address from elf */
	35	unsigned int size; /* size of section from elf */
	36	unsigned int offset; /* offset of section into elf file */
	37	unsigned int buf;
	38	};
	39
	40	struct vma_to_fileoffset_map { /* map of sections within an SPU program */
	41	struct vma_to_fileoffset_map next; / list pointer */
	42	unsigned int vma; /* SPU virtual memory address from elf */
	43	unsigned int size; /* size of section from elf */
	44	unsigned int offset; /* offset of section into elf file */
	45	unsigned int guard_ptr;
	46	unsigned int guard_val;
	47	/*
	48	* The guard pointer is an entry in the _ovly_buf_table,
	49	* computed using ovly.buf as the index into the table. Since
	50	* ovly.buf values begin at '1' to reference the first (or 0th)
	51	* entry in the _ovly_buf_table, the computation subtracts 1
	52	* from ovly.buf.
	53	* The guard value is stored in the _ovly_buf_table entry and
	54	* is an index (starting at 1) back to the _ovly_table entry
	55	* that is pointing at this _ovly_buf_table entry. So, for
	56	* example, for an overlay scenario with one overlay segment
	57	* and two overlay sections:
	58	* - Section 1 points to the first entry of the
	59	* _ovly_buf_table, which contains a guard value
	60	* of '1', referencing the first (index=0) entry of
	61	* _ovly_table.
	62	* - Section 2 points to the second entry of the
	63	* _ovly_buf_table, which contains a guard value
	64	* of '2', referencing the second (index=1) entry of
	65	* _ovly_table.
	66	*/
	67
	68	};
	69
a5598ca0 CL	70	struct spu_buffer {
	71	int last_guard_val;
	72	int ctx_sw_seen;
	73	unsigned long *buff;
	74	unsigned int head, tail;
	75	};
	76
	77
1474855d BN	78	/* The three functions below are for maintaining and accessing
	79	* the vma-to-fileoffset map.
	80	*/
	81	struct vma_to_fileoffset_map create_vma_map(const struct spu spu,
	82	u64 objectid);
	83	unsigned int vma_map_lookup(struct vma_to_fileoffset_map *map,
	84	unsigned int vma, const struct spu *aSpu,
	85	int *grd_val);
	86	void vma_map_free(struct vma_to_fileoffset_map *map);
	87
	88	/*
	89	* Entry point for SPU profiling.
	90	* cycles_reset is the SPU_CYCLES count value specified by the user.
	91	*/
	92	int start_spu_profiling(unsigned int cycles_reset);
	93
	94	void stop_spu_profiling(void);
	95
	96
	97	/* add the necessary profiling hooks */
	98	int spu_sync_start(void);
	99
	100	/* remove the hooks */
	101	int spu_sync_stop(void);
	102
	103	/* Record SPU program counter samples to the oprofile event buffer. */
	104	void spu_sync_buffer(int spu_num, unsigned int *samples,
	105	int num_samples);
	106
	107	void set_spu_profiling_frequency(unsigned int freq_khz, unsigned int cycles_reset);
	108
	109	#endif /* PR_UTIL_H */