xref: /onnv-gate/usr/src/uts/common/sys/kcpc.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_KCPC_H
28*0Sstevel@tonic-gate #define	_SYS_KCPC_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/cpc_impl.h>
33*0Sstevel@tonic-gate 
34*0Sstevel@tonic-gate #ifdef	__cplusplus
35*0Sstevel@tonic-gate extern "C" {
36*0Sstevel@tonic-gate #endif
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate /*
39*0Sstevel@tonic-gate  * Kernel clients need this file in order to know what a request is and how to
40*0Sstevel@tonic-gate  * program one.
41*0Sstevel@tonic-gate  */
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate typedef struct _kcpc_set kcpc_set_t;
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate #ifdef _KERNEL
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate /*
48*0Sstevel@tonic-gate  * Forward declarations.
49*0Sstevel@tonic-gate  */
50*0Sstevel@tonic-gate struct _kthread;
51*0Sstevel@tonic-gate struct cpu;
52*0Sstevel@tonic-gate typedef struct _kcpc_request kcpc_request_t;
53*0Sstevel@tonic-gate struct __pcbe_ops;
54*0Sstevel@tonic-gate 
55*0Sstevel@tonic-gate struct _kcpc_set {
56*0Sstevel@tonic-gate 	int			ks_flags;
57*0Sstevel@tonic-gate 	int			ks_nreqs;	/* Number of reqs */
58*0Sstevel@tonic-gate 	kcpc_request_t		*ks_req;	/* Pointer to reqs */
59*0Sstevel@tonic-gate 	uint64_t		*ks_data;	/* Data store for this set */
60*0Sstevel@tonic-gate 	kcpc_ctx_t		*ks_ctx;	/* ctx this set belongs to */
61*0Sstevel@tonic-gate };
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate struct _kcpc_request {
64*0Sstevel@tonic-gate 	void			*kr_config;
65*0Sstevel@tonic-gate 	int			kr_index;	/* indx of data for this req */
66*0Sstevel@tonic-gate 	int			kr_picnum;	/* Number of phys pic */
67*0Sstevel@tonic-gate 	kcpc_pic_t		*kr_picp;	/* Ptr to PIC in context */
68*0Sstevel@tonic-gate 	uint64_t		*kr_data;	/* Ptr to virtual 64-bit pic */
69*0Sstevel@tonic-gate 	char			kr_event[CPC_MAX_EVENT_LEN];
70*0Sstevel@tonic-gate 	uint64_t		kr_preset;
71*0Sstevel@tonic-gate 	uint_t			kr_flags;
72*0Sstevel@tonic-gate 	uint_t			kr_nattrs;
73*0Sstevel@tonic-gate 	kcpc_attr_t		*kr_attr;
74*0Sstevel@tonic-gate };
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate /*
77*0Sstevel@tonic-gate  * Bind the set to the indicated thread.
78*0Sstevel@tonic-gate  * Returns 0 on success, or an errno in case of error. If EINVAL is returned,
79*0Sstevel@tonic-gate  * a specific error code will be returned in the subcode parameter.
80*0Sstevel@tonic-gate  */
81*0Sstevel@tonic-gate extern int kcpc_bind_thread(kcpc_set_t *set, struct _kthread *t, int *subcode);
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate /*
84*0Sstevel@tonic-gate  * Bind the set to the indicated CPU.
85*0Sstevel@tonic-gate  * Same return convention as kcpc_bind_thread().
86*0Sstevel@tonic-gate  */
87*0Sstevel@tonic-gate extern int kcpc_bind_cpu(kcpc_set_t *set, int cpuid, int *subcode);
88*0Sstevel@tonic-gate 
89*0Sstevel@tonic-gate /*
90*0Sstevel@tonic-gate  * Request the system to sample the current state of the set into users buf.
91*0Sstevel@tonic-gate  */
92*0Sstevel@tonic-gate extern int kcpc_sample(kcpc_set_t *set, uint64_t *buf, hrtime_t *hrtime,
93*0Sstevel@tonic-gate     uint64_t *tick);
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate /*
96*0Sstevel@tonic-gate  * Unbind a request and release the associated resources.
97*0Sstevel@tonic-gate  */
98*0Sstevel@tonic-gate extern int kcpc_unbind(kcpc_set_t *set);
99*0Sstevel@tonic-gate 
100*0Sstevel@tonic-gate /*
101*0Sstevel@tonic-gate  * Preset the indicated request's counter and underlying PCBE config to the
102*0Sstevel@tonic-gate  * given value.
103*0Sstevel@tonic-gate  */
104*0Sstevel@tonic-gate extern int kcpc_preset(kcpc_set_t *set, int index, uint64_t preset);
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate /*
107*0Sstevel@tonic-gate  * Unfreeze the set and get it counting again.
108*0Sstevel@tonic-gate  */
109*0Sstevel@tonic-gate extern int kcpc_restart(kcpc_set_t *set);
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate extern int kcpc_enable(struct _kthread *t, int cmd, int enable);
112*0Sstevel@tonic-gate 
113*0Sstevel@tonic-gate /*
114*0Sstevel@tonic-gate  * Mark a thread's CPC context, if it exists, INVALID.
115*0Sstevel@tonic-gate  */
116*0Sstevel@tonic-gate extern void kcpc_invalidate(struct _kthread *t);
117*0Sstevel@tonic-gate 
118*0Sstevel@tonic-gate extern int kcpc_overflow_ast(void);
119*0Sstevel@tonic-gate extern uint_t kcpc_hw_overflow_intr(caddr_t, caddr_t);
120*0Sstevel@tonic-gate extern int kcpc_hw_cpu_hook(int cpuid, ulong_t *kcpc_cpumap);
121*0Sstevel@tonic-gate extern int kcpc_hw_lwp_hook(void);
122*0Sstevel@tonic-gate extern void kcpc_idle_save(struct cpu *cp);
123*0Sstevel@tonic-gate extern void kcpc_idle_restore(struct cpu *cp);
124*0Sstevel@tonic-gate 
125*0Sstevel@tonic-gate extern krwlock_t	kcpc_cpuctx_lock;  /* lock for 'kcpc_cpuctx' below */
126*0Sstevel@tonic-gate extern int		kcpc_cpuctx;	   /* number of cpu-specific contexts */
127*0Sstevel@tonic-gate 
128*0Sstevel@tonic-gate extern void kcpc_free_set(kcpc_set_t *set);
129*0Sstevel@tonic-gate 
130*0Sstevel@tonic-gate extern void *kcpc_next_config(void *token, void *current,
131*0Sstevel@tonic-gate     uint64_t **data);
132*0Sstevel@tonic-gate 
133*0Sstevel@tonic-gate /*
134*0Sstevel@tonic-gate  * Called by a PCBE to determine if nonprivileged access to counters should be
135*0Sstevel@tonic-gate  * allowed. Returns non-zero if non-privileged access is allowed, 0 if not.
136*0Sstevel@tonic-gate  */
137*0Sstevel@tonic-gate extern int kcpc_allow_nonpriv(void *token);
138*0Sstevel@tonic-gate 
139*0Sstevel@tonic-gate extern void kcpc_register_pcbe(struct __pcbe_ops *);
140*0Sstevel@tonic-gate 
141*0Sstevel@tonic-gate #endif /* _KERNEL */
142*0Sstevel@tonic-gate 
143*0Sstevel@tonic-gate #ifdef	__cplusplus
144*0Sstevel@tonic-gate }
145*0Sstevel@tonic-gate #endif
146*0Sstevel@tonic-gate 
147*0Sstevel@tonic-gate #endif /* _SYS_KCPC_H */
148