1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * Copyright (C) 2001-2003 Hewlett-Packard Co
4  *               Stephane Eranian <eranian@hpl.hp.com>
5  */
6 
7 #ifndef _UAPI_ASM_IA64_PERFMON_H
8 #define _UAPI_ASM_IA64_PERFMON_H
9 
10 /*
11  * perfmon commands supported on all CPU models
12  */
13 #define PFM_WRITE_PMCS		0x01
14 #define PFM_WRITE_PMDS		0x02
15 #define PFM_READ_PMDS		0x03
16 #define PFM_STOP		0x04
17 #define PFM_START		0x05
18 #define PFM_ENABLE		0x06 /* obsolete */
19 #define PFM_DISABLE		0x07 /* obsolete */
20 #define PFM_CREATE_CONTEXT	0x08
21 #define PFM_DESTROY_CONTEXT	0x09 /* obsolete use close() */
22 #define PFM_RESTART		0x0a
23 #define PFM_PROTECT_CONTEXT	0x0b /* obsolete */
24 #define PFM_GET_FEATURES	0x0c
25 #define PFM_DEBUG		0x0d
26 #define PFM_UNPROTECT_CONTEXT	0x0e /* obsolete */
27 #define PFM_GET_PMC_RESET_VAL	0x0f
28 #define PFM_LOAD_CONTEXT	0x10
29 #define PFM_UNLOAD_CONTEXT	0x11
30 
31 /*
32  * PMU model specific commands (may not be supported on all PMU models)
33  */
34 #define PFM_WRITE_IBRS		0x20
35 #define PFM_WRITE_DBRS		0x21
36 
37 /*
38  * context flags
39  */
40 #define PFM_FL_NOTIFY_BLOCK    	 0x01	/* block task on user level notifications */
41 #define PFM_FL_SYSTEM_WIDE	 0x02	/* create a system wide context */
42 #define PFM_FL_OVFL_NO_MSG	 0x80   /* do not post overflow/end messages for notification */
43 
44 /*
45  * event set flags
46  */
47 #define PFM_SETFL_EXCL_IDLE      0x01   /* exclude idle task (syswide only) XXX: DO NOT USE YET */
48 
49 /*
50  * PMC flags
51  */
52 #define PFM_REGFL_OVFL_NOTIFY	0x1	/* send notification on overflow */
53 #define PFM_REGFL_RANDOM	0x2	/* randomize sampling interval   */
54 
55 /*
56  * PMD/PMC/IBR/DBR return flags (ignored on input)
57  *
58  * Those flags are used on output and must be checked in case EAGAIN is returned
59  * by any of the calls using a pfarg_reg_t or pfarg_dbreg_t structure.
60  */
61 #define PFM_REG_RETFL_NOTAVAIL	(1UL<<31) /* set if register is implemented but not available */
62 #define PFM_REG_RETFL_EINVAL	(1UL<<30) /* set if register entry is invalid */
63 #define PFM_REG_RETFL_MASK	(PFM_REG_RETFL_NOTAVAIL|PFM_REG_RETFL_EINVAL)
64 
65 #define PFM_REG_HAS_ERROR(flag)	(((flag) & PFM_REG_RETFL_MASK) != 0)
66 
67 typedef unsigned char pfm_uuid_t[16];	/* custom sampling buffer identifier type */
68 
69 /*
70  * Request structure used to define a context
71  */
72 typedef struct {
73 	pfm_uuid_t     ctx_smpl_buf_id;	 /* which buffer format to use (if needed) */
74 	unsigned long  ctx_flags;	 /* noblock/block */
75 	unsigned short ctx_nextra_sets;	 /* number of extra event sets (you always get 1) */
76 	unsigned short ctx_reserved1;	 /* for future use */
77 	int	       ctx_fd;		 /* return arg: unique identification for context */
78 	void	       *ctx_smpl_vaddr;	 /* return arg: virtual address of sampling buffer, is used */
79 	unsigned long  ctx_reserved2[11];/* for future use */
80 } pfarg_context_t;
81 
82 /*
83  * Request structure used to write/read a PMC or PMD
84  */
85 typedef struct {
86 	unsigned int	reg_num;	   /* which register */
87 	unsigned short	reg_set;	   /* event set for this register */
88 	unsigned short	reg_reserved1;	   /* for future use */
89 
90 	unsigned long	reg_value;	   /* initial pmc/pmd value */
91 	unsigned long	reg_flags;	   /* input: pmc/pmd flags, return: reg error */
92 
93 	unsigned long	reg_long_reset;	   /* reset after buffer overflow notification */
94 	unsigned long	reg_short_reset;   /* reset after counter overflow */
95 
96 	unsigned long	reg_reset_pmds[4]; /* which other counters to reset on overflow */
97 	unsigned long	reg_random_seed;   /* seed value when randomization is used */
98 	unsigned long	reg_random_mask;   /* bitmask used to limit random value */
99 	unsigned long   reg_last_reset_val;/* return: PMD last reset value */
100 
101 	unsigned long	reg_smpl_pmds[4];  /* which pmds are accessed when PMC overflows */
102 	unsigned long	reg_smpl_eventid;  /* opaque sampling event identifier */
103 
104 	unsigned long   reg_reserved2[3];   /* for future use */
105 } pfarg_reg_t;
106 
107 typedef struct {
108 	unsigned int	dbreg_num;		/* which debug register */
109 	unsigned short	dbreg_set;		/* event set for this register */
110 	unsigned short	dbreg_reserved1;	/* for future use */
111 	unsigned long	dbreg_value;		/* value for debug register */
112 	unsigned long	dbreg_flags;		/* return: dbreg error */
113 	unsigned long	dbreg_reserved2[1];	/* for future use */
114 } pfarg_dbreg_t;
115 
116 typedef struct {
117 	unsigned int	ft_version;	/* perfmon: major [16-31], minor [0-15] */
118 	unsigned int	ft_reserved;	/* reserved for future use */
119 	unsigned long	reserved[4];	/* for future use */
120 } pfarg_features_t;
121 
122 typedef struct {
123 	pid_t		load_pid;	   /* process to load the context into */
124 	unsigned short	load_set;	   /* first event set to load */
125 	unsigned short	load_reserved1;	   /* for future use */
126 	unsigned long	load_reserved2[3]; /* for future use */
127 } pfarg_load_t;
128 
129 typedef struct {
130 	int		msg_type;		/* generic message header */
131 	int		msg_ctx_fd;		/* generic message header */
132 	unsigned long	msg_ovfl_pmds[4];	/* which PMDs overflowed */
133 	unsigned short  msg_active_set;		/* active set at the time of overflow */
134 	unsigned short  msg_reserved1;		/* for future use */
135 	unsigned int    msg_reserved2;		/* for future use */
136 	unsigned long	msg_tstamp;		/* for perf tuning/debug */
137 } pfm_ovfl_msg_t;
138 
139 typedef struct {
140 	int		msg_type;		/* generic message header */
141 	int		msg_ctx_fd;		/* generic message header */
142 	unsigned long	msg_tstamp;		/* for perf tuning */
143 } pfm_end_msg_t;
144 
145 typedef struct {
146 	int		msg_type;		/* type of the message */
147 	int		msg_ctx_fd;		/* unique identifier for the context */
148 	unsigned long	msg_tstamp;		/* for perf tuning */
149 } pfm_gen_msg_t;
150 
151 #define PFM_MSG_OVFL	1	/* an overflow happened */
152 #define PFM_MSG_END	2	/* task to which context was attached ended */
153 
154 typedef union {
155 	pfm_ovfl_msg_t	pfm_ovfl_msg;
156 	pfm_end_msg_t	pfm_end_msg;
157 	pfm_gen_msg_t	pfm_gen_msg;
158 } pfm_msg_t;
159 
160 /*
161  * Define the version numbers for both perfmon as a whole and the sampling buffer format.
162  */
163 #define PFM_VERSION_MAJ		 2U
164 #define PFM_VERSION_MIN		 0U
165 #define PFM_VERSION		 (((PFM_VERSION_MAJ&0xffff)<<16)|(PFM_VERSION_MIN & 0xffff))
166 #define PFM_VERSION_MAJOR(x)	 (((x)>>16) & 0xffff)
167 #define PFM_VERSION_MINOR(x)	 ((x) & 0xffff)
168 
169 
170 /*
171  * miscellaneous architected definitions
172  */
173 #define PMU_FIRST_COUNTER	4	/* first counting monitor (PMC/PMD) */
174 #define PMU_MAX_PMCS		256	/* maximum architected number of PMC registers */
175 #define PMU_MAX_PMDS		256	/* maximum architected number of PMD registers */
176 
177 
178 #endif /* _UAPI_ASM_IA64_PERFMON_H */
179