xref: /freebsd/sys/cddl/dev/dtrace/aarch64/dtrace_isa.c (revision 187d8a3ce55a4e2d41fbe61465d5ff4ac0fc6bd5)
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, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 #include <sys/cdefs.h>
27 
28 #include <sys/param.h>
29 #include <sys/systm.h>
30 #include <sys/dtrace_impl.h>
31 #include <sys/kernel.h>
32 #include <sys/stack.h>
33 #include <sys/pcpu.h>
34 
35 #include <machine/frame.h>
36 #include <machine/md_var.h>
37 
38 #include <vm/vm.h>
39 #include <vm/vm_param.h>
40 #include <vm/pmap.h>
41 
42 #include <machine/atomic.h>
43 #include <machine/db_machdep.h>
44 #include <machine/md_var.h>
45 #include <machine/stack.h>
46 #include <ddb/db_sym.h>
47 #include <ddb/ddb.h>
48 #include <sys/kdb.h>
49 
50 #include <cddl/dev/dtrace/dtrace_cddl.h>
51 
52 #include "regset.h"
53 
54 #define	MAX_USTACK_DEPTH  2048
55 
56 uint8_t dtrace_fuword8_nocheck(void *);
57 uint16_t dtrace_fuword16_nocheck(void *);
58 uint32_t dtrace_fuword32_nocheck(void *);
59 uint64_t dtrace_fuword64_nocheck(void *);
60 
61 void
62 dtrace_getpcstack(pc_t *pcstack, int pcstack_limit, int aframes,
63     uint32_t *intrpc)
64 {
65 	struct unwind_state state;
66 	int scp_offset;
67 	int depth;
68 
69 	depth = 0;
70 
71 	if (intrpc != 0) {
72 		pcstack[depth++] = (pc_t) intrpc;
73 	}
74 
75 	aframes++;
76 
77 	state.fp = (uintptr_t)__builtin_frame_address(0);
78 	state.pc = (uintptr_t)dtrace_getpcstack;
79 
80 	while (depth < pcstack_limit) {
81 		if (!unwind_frame(curthread, &state))
82 			break;
83 		if (!INKERNEL(state.pc))
84 			break;
85 
86 		/*
87 		 * NB: Unlike some other architectures, we don't need to
88 		 * explicitly insert cpu_dtrace_caller as it appears in the
89 		 * normal kernel stack trace rather than a special trap frame.
90 		 */
91 		if (aframes > 0) {
92 			aframes--;
93 		} else {
94 			pcstack[depth++] = state.pc;
95 		}
96 
97 	}
98 
99 	for (; depth < pcstack_limit; depth++) {
100 		pcstack[depth] = 0;
101 	}
102 }
103 
104 static int
105 dtrace_getustack_common(uint64_t *pcstack, int pcstack_limit, uintptr_t pc,
106     uintptr_t fp)
107 {
108 	volatile uint16_t *flags =
109 	    (volatile uint16_t *)&cpu_core[curcpu].cpuc_dtrace_flags;
110 	int ret = 0;
111 	uintptr_t oldfp = fp;
112 
113 	ASSERT(pcstack == NULL || pcstack_limit > 0);
114 
115 	while (pc != 0) {
116 		/*
117 		 * We limit the number of times we can go around this
118 		 * loop to account for a circular stack.
119 		 */
120 		if (ret++ >= MAX_USTACK_DEPTH) {
121 			*flags |= CPU_DTRACE_BADSTACK;
122 			cpu_core[curcpu].cpuc_dtrace_illval = fp;
123 			break;
124 		}
125 
126 		if (pcstack != NULL) {
127 			*pcstack++ = (uint64_t)pc;
128 			pcstack_limit--;
129 			if (pcstack_limit <= 0)
130 				break;
131 		}
132 
133 		if (fp == 0)
134 			break;
135 
136 		pc = dtrace_fuword64((void *)(fp +
137 		    offsetof(struct unwind_state, pc)));
138 		fp = dtrace_fuword64((void *)fp);
139 
140 		if (fp == oldfp) {
141 			*flags |= CPU_DTRACE_BADSTACK;
142 			cpu_core[curcpu].cpuc_dtrace_illval = fp;
143 			break;
144 		}
145 
146 		/*
147 		 * ARM64TODO:
148 		 *     This workaround might not be necessary. It needs to be
149 		 *     revised and removed from all architectures if found
150 		 *     unwanted. Leaving the original x86 comment for reference.
151 		 *
152 		 * This is totally bogus:  if we faulted, we're going to clear
153 		 * the fault and break.  This is to deal with the apparently
154 		 * broken Java stacks on x86.
155 		 */
156 		if (*flags & CPU_DTRACE_FAULT) {
157 			*flags &= ~CPU_DTRACE_FAULT;
158 			break;
159 		}
160 
161 		oldfp = fp;
162 	}
163 
164 	return (ret);
165 }
166 
167 void
168 dtrace_getupcstack(uint64_t *pcstack, int pcstack_limit)
169 {
170 	proc_t *p = curproc;
171 	struct trapframe *tf;
172 	uintptr_t pc, fp;
173 	volatile uint16_t *flags =
174 	    (volatile uint16_t *)&cpu_core[curcpu].cpuc_dtrace_flags;
175 	int n;
176 
177 	if (*flags & CPU_DTRACE_FAULT)
178 		return;
179 
180 	if (pcstack_limit <= 0)
181 		return;
182 
183 	/*
184 	 * If there's no user context we still need to zero the stack.
185 	 */
186 	if (p == NULL || (tf = curthread->td_frame) == NULL)
187 		goto zero;
188 
189 	*pcstack++ = (uint64_t)p->p_pid;
190 	pcstack_limit--;
191 
192 	if (pcstack_limit <= 0)
193 		return;
194 
195 	pc = tf->tf_elr;
196 	fp = tf->tf_x[29];
197 
198 	if (DTRACE_CPUFLAG_ISSET(CPU_DTRACE_ENTRY)) {
199 		/*
200 		 * In an entry probe.  The frame pointer has not yet been
201 		 * pushed (that happens in the function prologue).  The
202 		 * best approach is to add the current pc as a missing top
203 		 * of stack and back the pc up to the caller, which is stored
204 		 * at the current stack pointer address since the call
205 		 * instruction puts it there right before the branch.
206 		 */
207 
208 		*pcstack++ = (uint64_t)pc;
209 		pcstack_limit--;
210 		if (pcstack_limit <= 0)
211 			return;
212 
213 		pc = tf->tf_lr;
214 	}
215 
216 	n = dtrace_getustack_common(pcstack, pcstack_limit, pc, fp);
217 	ASSERT(n >= 0);
218 	ASSERT(n <= pcstack_limit);
219 
220 	pcstack += n;
221 	pcstack_limit -= n;
222 
223 zero:
224 	while (pcstack_limit-- > 0)
225 		*pcstack++ = 0;
226 }
227 
228 int
229 dtrace_getustackdepth(void)
230 {
231 	proc_t *p = curproc;
232 	struct trapframe *tf;
233 	uintptr_t pc, fp;
234 	int n = 0;
235 
236 	if (p == NULL || (tf = curthread->td_frame) == NULL)
237 		return (0);
238 
239 	if (DTRACE_CPUFLAG_ISSET(CPU_DTRACE_FAULT))
240 		return (-1);
241 
242 	pc = tf->tf_elr;
243 	fp = tf->tf_x[29];
244 	n += dtrace_getustack_common(NULL, 0, pc, fp);
245 
246 	return (n);
247 }
248 
249 void
250 dtrace_getufpstack(uint64_t *pcstack, uint64_t *fpstack, int pcstack_limit)
251 {
252 
253 	printf("IMPLEMENT ME: %s\n", __func__);
254 }
255 
256 uint64_t
257 dtrace_getarg(int arg, int aframes __unused)
258 {
259 	struct trapframe *tf;
260 
261 	/*
262 	 * We only handle invop providers here.
263 	 */
264 	if ((tf = curthread->t_dtrace_trapframe) == NULL) {
265 		DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP);
266 		return (0);
267 	} else if (arg < 8) {
268 		return (tf->tf_x[arg]);
269 	} else {
270 		uintptr_t p;
271 		uint64_t val;
272 
273 		p = (tf->tf_sp + (arg - 8) * sizeof(uint64_t));
274 		if ((p & 7) != 0) {
275 			DTRACE_CPUFLAG_SET(CPU_DTRACE_BADALIGN);
276 			cpu_core[curcpu].cpuc_dtrace_illval = p;
277 			return (0);
278 		}
279 		if (!kstack_contains(curthread, p, sizeof(uint64_t))) {
280 			DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR);
281 			cpu_core[curcpu].cpuc_dtrace_illval = p;
282 			return (0);
283 		}
284 		memcpy(&val, (void *)p, sizeof(uint64_t));
285 		return (val);
286 	}
287 }
288 
289 int
290 dtrace_getstackdepth(int aframes)
291 {
292 	struct unwind_state state;
293 	int scp_offset;
294 	int depth;
295 	bool done;
296 
297 	depth = 1;
298 	done = false;
299 
300 	state.fp = (uintptr_t)__builtin_frame_address(0);
301 	state.pc = (uintptr_t)dtrace_getstackdepth;
302 
303 	do {
304 		done = !unwind_frame(curthread, &state);
305 		if (!INKERNEL(state.pc) || !INKERNEL(state.fp))
306 			break;
307 		depth++;
308 	} while (!done);
309 
310 	if (depth < aframes)
311 		return (0);
312 	else
313 		return (depth - aframes);
314 }
315 
316 ulong_t
317 dtrace_getreg(struct trapframe *frame, uint_t reg)
318 {
319 	switch (reg) {
320 	case REG_X0 ... REG_X29:
321 		return (frame->tf_x[reg]);
322 	case REG_LR:
323 		return (frame->tf_lr);
324 	case REG_SP:
325 		return (frame->tf_sp);
326 	case REG_PC:
327 		return (frame->tf_elr);
328 	default:
329 		DTRACE_CPUFLAG_SET(CPU_DTRACE_ILLOP);
330 		return (0);
331 	}
332 	/* NOTREACHED */
333 }
334 
335 static int
336 dtrace_copycheck(uintptr_t uaddr, uintptr_t kaddr, size_t size)
337 {
338 
339 	if (uaddr + size > VM_MAXUSER_ADDRESS || uaddr + size < uaddr) {
340 		DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR);
341 		cpu_core[curcpu].cpuc_dtrace_illval = uaddr;
342 		return (0);
343 	}
344 
345 	return (1);
346 }
347 
348 void
349 dtrace_copyin(uintptr_t uaddr, uintptr_t kaddr, size_t size,
350     volatile uint16_t *flags)
351 {
352 
353 	if (dtrace_copycheck(uaddr, kaddr, size))
354 		dtrace_copy(uaddr, kaddr, size);
355 }
356 
357 void
358 dtrace_copyout(uintptr_t kaddr, uintptr_t uaddr, size_t size,
359     volatile uint16_t *flags)
360 {
361 
362 	if (dtrace_copycheck(uaddr, kaddr, size))
363 		dtrace_copy(kaddr, uaddr, size);
364 }
365 
366 void
367 dtrace_copyinstr(uintptr_t uaddr, uintptr_t kaddr, size_t size,
368     volatile uint16_t *flags)
369 {
370 
371 	if (dtrace_copycheck(uaddr, kaddr, size))
372 		dtrace_copystr(uaddr, kaddr, size, flags);
373 }
374 
375 void
376 dtrace_copyoutstr(uintptr_t kaddr, uintptr_t uaddr, size_t size,
377     volatile uint16_t *flags)
378 {
379 
380 	if (dtrace_copycheck(uaddr, kaddr, size))
381 		dtrace_copystr(kaddr, uaddr, size, flags);
382 }
383 
384 uint8_t
385 dtrace_fuword8(void *uaddr)
386 {
387 
388 	if ((uintptr_t)uaddr > VM_MAXUSER_ADDRESS) {
389 		DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR);
390 		cpu_core[curcpu].cpuc_dtrace_illval = (uintptr_t)uaddr;
391 		return (0);
392 	}
393 
394 	return (dtrace_fuword8_nocheck(uaddr));
395 }
396 
397 uint16_t
398 dtrace_fuword16(void *uaddr)
399 {
400 
401 	if ((uintptr_t)uaddr > VM_MAXUSER_ADDRESS) {
402 		DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR);
403 		cpu_core[curcpu].cpuc_dtrace_illval = (uintptr_t)uaddr;
404 		return (0);
405 	}
406 
407 	return (dtrace_fuword16_nocheck(uaddr));
408 }
409 
410 uint32_t
411 dtrace_fuword32(void *uaddr)
412 {
413 
414 	if ((uintptr_t)uaddr > VM_MAXUSER_ADDRESS) {
415 		DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR);
416 		cpu_core[curcpu].cpuc_dtrace_illval = (uintptr_t)uaddr;
417 		return (0);
418 	}
419 
420 	return (dtrace_fuword32_nocheck(uaddr));
421 }
422 
423 uint64_t
424 dtrace_fuword64(void *uaddr)
425 {
426 
427 	if ((uintptr_t)uaddr > VM_MAXUSER_ADDRESS) {
428 		DTRACE_CPUFLAG_SET(CPU_DTRACE_BADADDR);
429 		cpu_core[curcpu].cpuc_dtrace_illval = (uintptr_t)uaddr;
430 		return (0);
431 	}
432 
433 	return (dtrace_fuword64_nocheck(uaddr));
434 }
435