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 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
24 */
25
26 #include <sys/param.h>
27 #include <sys/systm.h>
28 #include <sys/errno.h>
29 #include <sys/stat.h>
30 #include <sys/ioctl.h>
31 #include <sys/conf.h>
32 #include <sys/fcntl.h>
33 #include <miscfs/devfs/devfs.h>
34
35 #include <sys/dtrace.h>
36 #include <sys/dtrace_impl.h>
37
38 #include <sys/dtrace_glue.h>
39
40 #include <sys/lockstat.h>
41
42 #include <kern/lock_stat.h>
43
44 #define membar_producer dtrace_membar_producer
45
46 #define PROBE_ARGS0(a, b, c, d, e) "\000"
47 #define PROBE_ARGS1(a, b, c, d, e) a "\000"
48 #define PROBE_ARGS2(a, b, c, d, e) a "\000" b "\000"
49 #define PROBE_ARGS3(a, b, c, d, e) a "\000" b "\000" c "\000"
50 #define PROBE_ARGS4(a, b, c, d, e) a "\000" b "\000" c "\000" d "\000"
51 #define PROBE_ARGS5(a, b, c, d, e) a "\000" b "\000" c "\000" d "\000" e "\000"
52 #define PROBE_ARGS_(a, b, c, d, e, n, ...) PROBE_ARGS##n(a, b, c, d, e)
53 #define PROBE_ARGS(...) PROBE_ARGS_(__VA_ARGS__, 5, 4, 3, 2, 1, 0)
54
55 #define LOCKSTAT_PROBE(func, name, probe, ...) \
56 {func, name, probe, DTRACE_IDNONE, PROBE_ARGS(__VA_ARGS__)}
57
58 #if defined(__x86_64__)
59 #define LOCKSTAT_AFRAMES 1
60 #elif defined(__arm__) || defined(__arm64__)
61 #define LOCKSTAT_AFRAMES 2
62 #else
63 #error "architecture not supported"
64 #endif
65
66 typedef struct lockstat_probe {
67 const char *lsp_func;
68 const char *lsp_name;
69 int lsp_probe;
70 dtrace_id_t lsp_id;
71 const char *lsp_args;
72 } lockstat_probe_t;
73
74 lockstat_probe_t lockstat_probes[] =
75 {
76 // Mutex probes
77 LOCKSTAT_PROBE(LS_LCK_MTX_LOCK, LSA_ACQUIRE, LS_LCK_MTX_LOCK_ACQUIRE, "lck_mtx_t"),
78 LOCKSTAT_PROBE(LS_LCK_MTX_LOCK, LSA_SPIN, LS_LCK_MTX_LOCK_SPIN, "lck_mtx_t", "uint64_t"),
79 LOCKSTAT_PROBE(LS_LCK_MTX_LOCK, LSA_BLOCK, LS_LCK_MTX_LOCK_BLOCK, "lck_mtx_t", "uint64_t"),
80 LOCKSTAT_PROBE(LS_LCK_MTX_TRY_LOCK, LSA_ACQUIRE, LS_LCK_MTX_TRY_LOCK_ACQUIRE, "lck_mtx_t"),
81 LOCKSTAT_PROBE(LS_LCK_MTX_TRY_SPIN_LOCK, LSA_ACQUIRE, LS_LCK_MTX_TRY_SPIN_LOCK_ACQUIRE, "lck_mtx_t"),
82 LOCKSTAT_PROBE(LS_LCK_MTX_UNLOCK, LSA_RELEASE, LS_LCK_MTX_UNLOCK_RELEASE, "lck_mtx_t"),
83 LOCKSTAT_PROBE(LS_LCK_MTX_LOCK_SPIN_LOCK, LSA_ACQUIRE, LS_LCK_MTX_LOCK_SPIN_ACQUIRE, "lck_mtx_t"),
84 // Extended mutexes are only implemented on Intel
85 #if defined(__x86_64__)
86 LOCKSTAT_PROBE(LS_LCK_MTX_EXT_LOCK, LSA_SPIN, LS_LCK_MTX_EXT_LOCK_SPIN, "lck_mtx_t", "uint64_t"),
87 LOCKSTAT_PROBE(LS_LCK_MTX_EXT_LOCK, LSA_ACQUIRE, LS_LCK_MTX_EXT_LOCK_ACQUIRE, "lck_mtx_t"),
88 LOCKSTAT_PROBE(LS_LCK_MTX_EXT_LOCK, LSA_BLOCK, LS_LCK_MTX_EXT_LOCK_BLOCK, "lck_mtx_t", "uint64_t"),
89 LOCKSTAT_PROBE(LS_LCK_MTX_EXT_UNLOCK, LSA_RELEASE, LS_LCK_MTX_EXT_UNLOCK_RELEASE, "lck_mtx_t"),
90 #endif
91
92 // RW lock probes
93 // TODO: This should not be a uint64_t !
94 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_SHARED, LSR_ACQUIRE, LS_LCK_RW_LOCK_SHARED_ACQUIRE, "lck_rw_t", "uint64_t"),
95 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_SHARED, LSR_BLOCK, LS_LCK_RW_LOCK_SHARED_BLOCK, "lck_rw_t", "uint64_t", "_Bool", "_Bool", "int"),
96 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_SHARED, LSR_SPIN, LS_LCK_RW_LOCK_SHARED_SPIN, "lck_rw_t", "uint64_t", "_Bool", "_Bool", "int"),
97 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_EXCL, LSR_ACQUIRE, LS_LCK_RW_LOCK_EXCL_ACQUIRE, "lck_rw_t", "uint64_t"),
98 // TODO: This should NOT be a uint64_t
99 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_EXCL, LSR_BLOCK, LS_LCK_RW_LOCK_EXCL_BLOCK, "lck_rw_t", "uint64_t", "_Bool", "_Bool", "int"),
100 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_EXCL, LSR_SPIN, LS_LCK_RW_LOCK_EXCL_SPIN, "lck_rw_t", "uint64_t", "int"),
101 LOCKSTAT_PROBE(LS_LCK_RW_DONE, LSR_RELEASE, LS_LCK_RW_DONE_RELEASE, "lck_rw_t", "_Bool"),
102 // TODO : This should NOT be a uint64_t
103 LOCKSTAT_PROBE(LS_LCK_RW_TRY_LOCK_SHARED, LSR_ACQUIRE, LS_LCK_RW_TRY_LOCK_SHARED_ACQUIRE, "lck_rw_t", "uint64_t"),
104 LOCKSTAT_PROBE(LS_LCK_RW_TRY_LOCK_EXCL, LSR_ACQUIRE, LS_LCK_RW_TRY_LOCK_EXCL_ACQUIRE, "lck_rw_t", "uint64_t"),
105 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_SHARED_TO_EXCL, LSR_UPGRADE, LS_LCK_RW_LOCK_SHARED_TO_EXCL_UPGRADE, "lck_rw_t", "_Bool"),
106 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_SHARED_TO_EXCL, LSR_SPIN, LS_LCK_RW_LOCK_SHARED_TO_EXCL_SPIN, "lck_rw_t", "uint64_t"),
107 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_SHARED_TO_EXCL, LSR_BLOCK, LS_LCK_RW_LOCK_SHARED_TO_EXCL_BLOCK, "lck_rw_t", "uint64_t", "_Bool", "_Bool", "int"),
108
109 // Spin lock probes
110 //TODO : Separate the probes for the hw_bit from the probe for the normal hw locks
111 LOCKSTAT_PROBE(LS_LCK_SPIN_LOCK, LSS_ACQUIRE, LS_LCK_SPIN_LOCK_ACQUIRE, "hw_lock_t"),
112 LOCKSTAT_PROBE(LS_LCK_SPIN_LOCK, LSS_SPIN, LS_LCK_SPIN_LOCK_SPIN, "hw_lock_t", "uint64_t", "uint64_t"),
113 LOCKSTAT_PROBE(LS_LCK_SPIN_UNLOCK, LSS_RELEASE, LS_LCK_SPIN_UNLOCK_RELEASE, "hw_lock_t"),
114 LOCKSTAT_PROBE(LS_LCK_RW_LOCK_EXCL_TO_SHARED, LSR_DOWNGRADE, LS_LCK_RW_LOCK_EXCL_TO_SHARED_DOWNGRADE, "lck_rw_t"),
115 // Ticket lock probes
116 LOCKSTAT_PROBE(LS_LCK_TICKET_LOCK, LST_ACQUIRE, LS_LCK_TICKET_LOCK_ACQUIRE, "lck_ticket_t"),
117 LOCKSTAT_PROBE(LS_LCK_TICKET_LOCK, LST_RELEASE, LS_LCK_TICKET_LOCK_RELEASE, "lck_ticket_t"),
118 LOCKSTAT_PROBE(LS_LCK_TICKET_LOCK, LST_SPIN, LS_LCK_TICKET_LOCK_SPIN, "lck_ticket_t"),
119 {
120 NULL, NULL, 0, 0, NULL
121 }
122 };
123
124 dtrace_id_t lockstat_probemap[LS_NPROBES];
125
126 static dtrace_provider_id_t lockstat_id;
127
128 /*ARGSUSED*/
129 static int
lockstat_enable(void * arg,dtrace_id_t id,void * parg)130 lockstat_enable(void *arg, dtrace_id_t id, void *parg)
131 {
132 #pragma unused(arg) /* __APPLE__ */
133
134 lockstat_probe_t *probe = parg;
135
136 ASSERT(!lockstat_probemap[probe->lsp_probe]);
137
138 lockstat_probemap[probe->lsp_probe] = id;
139 membar_producer();
140
141 return 0;
142 }
143
144 /*ARGSUSED*/
145 static void
lockstat_disable(void * arg,dtrace_id_t id,void * parg)146 lockstat_disable(void *arg, dtrace_id_t id, void *parg)
147 {
148 #pragma unused(arg, id) /* __APPLE__ */
149
150 lockstat_probe_t *probe = parg;
151
152 ASSERT(lockstat_probemap[probe->lsp_probe]);
153
154 lockstat_probemap[probe->lsp_probe] = 0;
155 membar_producer();
156 }
157
158 /*ARGSUSED*/
159 static void
lockstat_provide(void * arg,const dtrace_probedesc_t * desc)160 lockstat_provide(void *arg, const dtrace_probedesc_t *desc)
161 {
162 #pragma unused(arg, desc) /* __APPLE__ */
163
164 int i = 0;
165
166 for (i = 0; lockstat_probes[i].lsp_func != NULL; i++) {
167 lockstat_probe_t *probe = &lockstat_probes[i];
168
169 if (dtrace_probe_lookup(lockstat_id, "mach_kernel",
170 probe->lsp_func, probe->lsp_name) != 0) {
171 continue;
172 }
173
174 ASSERT(!probe->lsp_id);
175 probe->lsp_id = dtrace_probe_create(lockstat_id,
176 "mach_kernel", probe->lsp_func, probe->lsp_name,
177 LOCKSTAT_AFRAMES, probe);
178 }
179 }
180
181
182 /*ARGSUSED*/
183 static void
lockstat_destroy(void * arg,dtrace_id_t id,void * parg)184 lockstat_destroy(void *arg, dtrace_id_t id, void *parg)
185 {
186 #pragma unused(arg, id)
187
188 lockstat_probe_t *probe = parg;
189
190 ASSERT(!lockstat_probemap[probe->lsp_probe]);
191 probe->lsp_id = 0;
192 }
193
194 static void
lockstat_getargdesc(void * arg,dtrace_id_t id,void * parg,dtrace_argdesc_t * desc)195 lockstat_getargdesc(void *arg, dtrace_id_t id, void *parg, dtrace_argdesc_t *desc)
196 {
197 #pragma unused(arg, id)
198 lockstat_probe_t *probe = parg;
199 const char* argdesc = probe->lsp_args;
200 int narg = 0;
201
202 desc->dtargd_native[0] = '\0';
203 desc->dtargd_xlate[0] = '\0';
204
205 while (argdesc[0] != '\0') {
206 if (narg == desc->dtargd_ndx) {
207 strlcpy(desc->dtargd_native, argdesc, DTRACE_ARGTYPELEN);
208 return;
209 }
210 argdesc += strlen(argdesc) + 1;
211 narg++;
212 }
213
214 desc->dtargd_ndx = DTRACE_ARGNONE;
215 }
216
217 static dtrace_pattr_t lockstat_attr = {
218 { DTRACE_STABILITY_EVOLVING, DTRACE_STABILITY_EVOLVING, DTRACE_CLASS_COMMON },
219 { DTRACE_STABILITY_PRIVATE, DTRACE_STABILITY_PRIVATE, DTRACE_CLASS_UNKNOWN },
220 { DTRACE_STABILITY_PRIVATE, DTRACE_STABILITY_PRIVATE, DTRACE_CLASS_UNKNOWN },
221 { DTRACE_STABILITY_EVOLVING, DTRACE_STABILITY_EVOLVING, DTRACE_CLASS_COMMON },
222 { DTRACE_STABILITY_EVOLVING, DTRACE_STABILITY_EVOLVING, DTRACE_CLASS_COMMON },
223 };
224
225 static dtrace_pops_t lockstat_pops = {
226 .dtps_provide = lockstat_provide,
227 .dtps_provide_module = NULL,
228 .dtps_enable = lockstat_enable,
229 .dtps_disable = lockstat_disable,
230 .dtps_suspend = NULL,
231 .dtps_resume = NULL,
232 .dtps_getargdesc = lockstat_getargdesc,
233 .dtps_getargval = NULL,
234 .dtps_usermode = NULL,
235 .dtps_destroy = lockstat_destroy
236 };
237
238 static int
lockstat_attach(dev_info_t * devi)239 lockstat_attach(dev_info_t *devi)
240 {
241 if (ddi_create_minor_node(devi, "lockstat", S_IFCHR, 0,
242 DDI_PSEUDO, 0) == DDI_FAILURE ||
243 dtrace_register("lockstat", &lockstat_attr, DTRACE_PRIV_KERNEL,
244 NULL, &lockstat_pops, NULL, &lockstat_id) != 0) {
245 ddi_remove_minor_node(devi, NULL);
246 return DDI_FAILURE;
247 }
248
249 return DDI_SUCCESS;
250 }
251
252 static int
_lockstat_open(dev_t dev,int flags,int devtype,struct proc * p)253 _lockstat_open(dev_t dev, int flags, int devtype, struct proc *p)
254 {
255 #pragma unused(dev,flags,devtype,p)
256 return 0;
257 }
258
259
260 static const struct cdevsw lockstat_cdevsw =
261 {
262 .d_open = _lockstat_open,
263 .d_close = eno_opcl,
264 .d_read = eno_rdwrt,
265 .d_write = eno_rdwrt,
266 .d_ioctl = eno_ioctl,
267 .d_stop = (stop_fcn_t *)nulldev,
268 .d_reset = (reset_fcn_t *)nulldev,
269 .d_select = eno_select,
270 .d_mmap = eno_mmap,
271 .d_strategy = eno_strat,
272 .d_reserved_1 = eno_getc,
273 .d_reserved_2 = eno_putc,
274 };
275
276 void lockstat_init( void );
277
278 void
lockstat_init(void)279 lockstat_init( void )
280 {
281 int majdevno = cdevsw_add(-1, &lockstat_cdevsw);
282
283 if (majdevno < 0) {
284 printf("lockstat_init: failed to allocate a major number!\n");
285 return;
286 }
287
288 lockstat_attach((dev_info_t*)(uintptr_t)majdevno);
289 }
290