xref: /illumos-gate/usr/src/uts/common/sys/kcpc.h (revision 15deec58)
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 2007 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 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 /*
38  * Kernel clients need this file in order to know what a request is and how to
39  * program one.
40  */
41 
42 typedef struct _kcpc_set kcpc_set_t;
43 
44 #ifdef _KERNEL
45 
46 /*
47  * Forward declarations.
48  */
49 struct _kthread;
50 struct cpu;
51 typedef struct _kcpc_request kcpc_request_t;
52 struct __pcbe_ops;
53 
54 struct _kcpc_set {
55 	int			ks_flags;
56 	int			ks_nreqs;	/* Number of reqs */
57 	kcpc_request_t		*ks_req;	/* Pointer to reqs */
58 	uint64_t		*ks_data;	/* Data store for this set */
59 	kcpc_ctx_t		*ks_ctx;	/* ctx this set belongs to */
60 };
61 
62 struct _kcpc_request {
63 	void			*kr_config;
64 	int			kr_index;	/* indx of data for this req */
65 	int			kr_picnum;	/* Number of phys pic */
66 	kcpc_pic_t		*kr_picp;	/* Ptr to PIC in context */
67 	uint64_t		*kr_data;	/* Ptr to virtual 64-bit pic */
68 	char			kr_event[CPC_MAX_EVENT_LEN];
69 	uint64_t		kr_preset;
70 	uint_t			kr_flags;
71 	uint_t			kr_nattrs;
72 	kcpc_attr_t		*kr_attr;
73 };
74 
75 /*
76  * Bind the set to the indicated thread.
77  * Returns 0 on success, or an errno in case of error. If EINVAL is returned,
78  * a specific error code will be returned in the subcode parameter.
79  */
80 extern int kcpc_bind_thread(kcpc_set_t *set, struct _kthread *t, int *subcode);
81 
82 /*
83  * Bind the set to the indicated CPU.
84  * Same return convention as kcpc_bind_thread().
85  */
86 extern int kcpc_bind_cpu(kcpc_set_t *set, int cpuid, int *subcode);
87 
88 /*
89  * Request the system to sample the current state of the set into users buf.
90  */
91 extern int kcpc_sample(kcpc_set_t *set, uint64_t *buf, hrtime_t *hrtime,
92     uint64_t *tick);
93 
94 /*
95  * Unbind a request and release the associated resources.
96  */
97 extern int kcpc_unbind(kcpc_set_t *set);
98 
99 /*
100  * Preset the indicated request's counter and underlying PCBE config to the
101  * given value.
102  */
103 extern int kcpc_preset(kcpc_set_t *set, int index, uint64_t preset);
104 
105 /*
106  * Unfreeze the set and get it counting again.
107  */
108 extern int kcpc_restart(kcpc_set_t *set);
109 
110 extern int kcpc_enable(struct _kthread *t, int cmd, int enable);
111 
112 /*
113  * Mark a thread's CPC context, if it exists, INVALID.
114  */
115 extern void kcpc_invalidate(struct _kthread *t);
116 
117 extern int kcpc_overflow_ast(void);
118 extern uint_t kcpc_hw_overflow_intr(caddr_t, caddr_t);
119 extern int kcpc_hw_cpu_hook(int cpuid, ulong_t *kcpc_cpumap);
120 extern int kcpc_hw_lwp_hook(void);
121 extern void kcpc_idle_save(struct cpu *cp);
122 extern void kcpc_idle_restore(struct cpu *cp);
123 
124 extern krwlock_t	kcpc_cpuctx_lock;  /* lock for 'kcpc_cpuctx' below */
125 extern int		kcpc_cpuctx;	   /* number of cpu-specific contexts */
126 
127 extern void kcpc_free_set(kcpc_set_t *set);
128 
129 extern void *kcpc_next_config(void *token, void *current,
130     uint64_t **data);
131 extern void kcpc_invalidate_config(void *token);
132 
133 /*
134  * Called by a PCBE to determine if nonprivileged access to counters should be
135  * allowed. Returns non-zero if non-privileged access is allowed, 0 if not.
136  */
137 extern int kcpc_allow_nonpriv(void *token);
138 
139 extern void kcpc_register_pcbe(struct __pcbe_ops *);
140 
141 #endif /* _KERNEL */
142 
143 #ifdef	__cplusplus
144 }
145 #endif
146 
147 #endif /* _SYS_KCPC_H */
148