xref: /freebsd/sys/cddl/dev/fbt/arm/fbt_isa.c (revision f4bf2442a03f9b72cfe6d051766b650a4721f3d8)
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  * Portions Copyright 2006-2008 John Birrell jb@freebsd.org
22  * Portions Copyright 2013 Justin Hibbits jhibbits@freebsd.org
23  * Portions Copyright 2013 Howard Su howardsu@freebsd.org
24  *
25  * $FreeBSD$
26  *
27  */
28 
29 /*
30  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
31  * Use is subject to license terms.
32  */
33 
34 #include <sys/cdefs.h>
35 #include <sys/param.h>
36 
37 #include <sys/dtrace.h>
38 #include <machine/stack.h>
39 #include <machine/trap.h>
40 
41 #include "fbt.h"
42 
43 #define	FBT_PUSHM		0xe92d0000
44 #define	FBT_POPM		0xe8bd0000
45 #define	FBT_JUMP		0xea000000
46 #define	FBT_SUBSP		0xe24dd000
47 
48 #define	FBT_ENTRY	"entry"
49 #define	FBT_RETURN	"return"
50 
51 int
52 fbt_invop(uintptr_t addr, struct trapframe *frame, uintptr_t rval)
53 {
54 	solaris_cpu_t *cpu = &solaris_cpu[curcpu];
55 	fbt_probe_t *fbt = fbt_probetab[FBT_ADDR2NDX(addr)];
56 	register_t fifthparam;
57 
58 	for (; fbt != NULL; fbt = fbt->fbtp_hashnext) {
59 		if ((uintptr_t)fbt->fbtp_patchpoint == addr) {
60 			cpu->cpu_dtrace_caller = addr;
61 
62 			/* Get 5th parameter from stack */
63 			DTRACE_CPUFLAG_SET(CPU_DTRACE_NOFAULT);
64 			fifthparam = *(register_t *)frame->tf_usr_sp;
65 			DTRACE_CPUFLAG_CLEAR(CPU_DTRACE_NOFAULT | CPU_DTRACE_BADADDR);
66 
67 			dtrace_probe(fbt->fbtp_id, frame->tf_r0,
68 			    frame->tf_r1, frame->tf_r2,
69 			    frame->tf_r3, fifthparam);
70 
71 			cpu->cpu_dtrace_caller = 0;
72 
73 			return (fbt->fbtp_rval | (fbt->fbtp_savedval << DTRACE_INVOP_SHIFT));
74 		}
75 	}
76 
77 	return (0);
78 }
79 
80 void
81 fbt_patch_tracepoint(fbt_probe_t *fbt, fbt_patchval_t val)
82 {
83 
84 	*fbt->fbtp_patchpoint = val;
85 	icache_sync((vm_offset_t)fbt->fbtp_patchpoint, sizeof(val));
86 }
87 
88 int
89 fbt_provide_module_function(linker_file_t lf, int symindx,
90     linker_symval_t *symval, void *opaque)
91 {
92 	char *modname = opaque;
93 	const char *name = symval->name;
94 	fbt_probe_t *fbt, *retfbt;
95 	uint32_t *instr, *limit;
96 	int popm;
97 
98 	if (strncmp(name, "dtrace_", 7) == 0 &&
99 	    strncmp(name, "dtrace_safe_", 12) != 0) {
100 		/*
101 		 * Anything beginning with "dtrace_" may be called
102 		 * from probe context unless it explicitly indicates
103 		 * that it won't be called from probe context by
104 		 * using the prefix "dtrace_safe_".
105 		 */
106 		return (0);
107 	}
108 
109 	if (name[0] == '_' && name[1] == '_')
110 		return (0);
111 
112 	instr = (uint32_t *)symval->value;
113 	limit = (uint32_t *)(symval->value + symval->size);
114 
115 	/*
116 	 * va_arg functions has first instruction of
117 	 * sub sp, sp, #?
118 	 */
119 	if ((*instr & 0xfffff000) == FBT_SUBSP)
120 		instr++;
121 
122 	/*
123 	 * check if insn is a pushm with LR
124 	 */
125 	if ((*instr & 0xffff0000) != FBT_PUSHM ||
126 	    (*instr & (1 << LR)) == 0)
127 		return (0);
128 
129 	fbt = malloc(sizeof (fbt_probe_t), M_FBT, M_WAITOK | M_ZERO);
130 	fbt->fbtp_name = name;
131 	fbt->fbtp_id = dtrace_probe_create(fbt_id, modname,
132 	    name, FBT_ENTRY, 2, fbt);
133 	fbt->fbtp_patchpoint = instr;
134 	fbt->fbtp_ctl = lf;
135 	fbt->fbtp_loadcnt = lf->loadcnt;
136 	fbt->fbtp_savedval = *instr;
137 	fbt->fbtp_patchval = FBT_BREAKPOINT;
138 	fbt->fbtp_rval = DTRACE_INVOP_PUSHM;
139 	fbt->fbtp_symindx = symindx;
140 
141 	fbt->fbtp_hashnext = fbt_probetab[FBT_ADDR2NDX(instr)];
142 	fbt_probetab[FBT_ADDR2NDX(instr)] = fbt;
143 
144 	lf->fbt_nentries++;
145 
146 	popm = FBT_POPM | ((*instr) & 0x3FFF) | 0x8000;
147 
148 	retfbt = NULL;
149 again:
150 	for (; instr < limit; instr++) {
151 		if (*instr == popm)
152 			break;
153 		else if ((*instr & 0xff000000) == FBT_JUMP) {
154 			uint32_t *target, *start;
155 			int offset;
156 
157 			offset = (*instr & 0xffffff);
158 			offset <<= 8;
159 			offset /= 64;
160 			target = instr + (2 + offset);
161 			start = (uint32_t *)symval->value;
162 			if (target >= limit || target < start)
163 				break;
164 		}
165 	}
166 
167 	if (instr >= limit)
168 		return (0);
169 
170 	/*
171 	 * We have a winner!
172 	 */
173 	fbt = malloc(sizeof (fbt_probe_t), M_FBT, M_WAITOK | M_ZERO);
174 	fbt->fbtp_name = name;
175 	if (retfbt == NULL) {
176 		fbt->fbtp_id = dtrace_probe_create(fbt_id, modname,
177 		    name, FBT_RETURN, 2, fbt);
178 	} else {
179 		retfbt->fbtp_next = fbt;
180 		fbt->fbtp_id = retfbt->fbtp_id;
181 	}
182 	retfbt = fbt;
183 
184 	fbt->fbtp_patchpoint = instr;
185 	fbt->fbtp_ctl = lf;
186 	fbt->fbtp_loadcnt = lf->loadcnt;
187 	fbt->fbtp_symindx = symindx;
188 	if ((*instr & 0xff000000) == FBT_JUMP)
189 		fbt->fbtp_rval = DTRACE_INVOP_B;
190 	else
191 		fbt->fbtp_rval = DTRACE_INVOP_POPM;
192 	fbt->fbtp_savedval = *instr;
193 	fbt->fbtp_patchval = FBT_BREAKPOINT;
194 	fbt->fbtp_hashnext = fbt_probetab[FBT_ADDR2NDX(instr)];
195 	fbt_probetab[FBT_ADDR2NDX(instr)] = fbt;
196 
197 	lf->fbt_nentries++;
198 
199 	instr++;
200 	goto again;
201 }
202