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