xref: /freebsd/sys/kern/subr_prof.c (revision 5ebc7e6281887681c3a348a5a4c902e262ccd656)
1 /*-
2  * Copyright (c) 1982, 1986, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)subr_prof.c	8.3 (Berkeley) 9/23/93
34  * $Id: subr_prof.c,v 1.5 1995/01/29 03:03:23 bde Exp $
35  */
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/proc.h>
41 #include <vm/vm.h>
42 #include <sys/sysctl.h>
43 #include <sys/user.h>
44 
45 #include <machine/cpu.h>
46 
47 #ifdef GPROF
48 #include <sys/malloc.h>
49 #include <sys/gmon.h>
50 
51 struct gmonparam _gmonparam = { GMON_PROF_OFF };
52 
53 extern char btext[];
54 extern char etext[];
55 
56 void
57 kmstartup()
58 {
59 	char *cp;
60 	struct gmonparam *p = &_gmonparam;
61 	/*
62 	 * Round lowpc and highpc to multiples of the density we're using
63 	 * so the rest of the scaling (here and in gprof) stays in ints.
64 	 */
65 	p->lowpc = ROUNDDOWN((u_long)btext, HISTFRACTION * sizeof(HISTCOUNTER));
66 	p->highpc = ROUNDUP((u_long)etext, HISTFRACTION * sizeof(HISTCOUNTER));
67 	p->textsize = p->highpc - p->lowpc;
68 	printf("Profiling kernel, textsize=%d [%x..%x]\n",
69 	       p->textsize, p->lowpc, p->highpc);
70 	p->kcountsize = p->textsize / HISTFRACTION;
71 	p->hashfraction = HASHFRACTION;
72 	p->fromssize = p->textsize / HASHFRACTION;
73 	p->tolimit = p->textsize * ARCDENSITY / 100;
74 	if (p->tolimit < MINARCS)
75 		p->tolimit = MINARCS;
76 	else if (p->tolimit > MAXARCS)
77 		p->tolimit = MAXARCS;
78 	p->tossize = p->tolimit * sizeof(struct tostruct);
79 	cp = (char *)malloc(p->kcountsize + p->fromssize + p->tossize,
80 	    M_GPROF, M_NOWAIT);
81 	if (cp == 0) {
82 		printf("No memory for profiling.\n");
83 		return;
84 	}
85 	bzero(cp, p->kcountsize + p->tossize + p->fromssize);
86 	p->tos = (struct tostruct *)cp;
87 	cp += p->tossize;
88 	p->kcount = (u_short *)cp;
89 	cp += p->kcountsize;
90 	p->froms = (u_short *)cp;
91 }
92 
93 /*
94  * Return kernel profiling information.
95  */
96 int
97 sysctl_doprof(name, namelen, oldp, oldlenp, newp, newlen)
98 	int *name;
99 	u_int namelen;
100 	void *oldp;
101 	size_t *oldlenp;
102 	void *newp;
103 	size_t newlen;
104 {
105 	struct gmonparam *gp = &_gmonparam;
106 	int error;
107 
108 	/* all sysctl names at this level are terminal */
109 	if (namelen != 1)
110 		return (ENOTDIR);		/* overloaded */
111 
112 	switch (name[0]) {
113 	case GPROF_STATE:
114 		error = sysctl_int(oldp, oldlenp, newp, newlen, &gp->state);
115 		if (error)
116 			return (error);
117 		if (gp->state == GMON_PROF_OFF)
118 			stopprofclock(&proc0);
119 		else
120 			startprofclock(&proc0);
121 		return (0);
122 	case GPROF_COUNT:
123 		return (sysctl_struct(oldp, oldlenp, newp, newlen,
124 		    gp->kcount, gp->kcountsize));
125 	case GPROF_FROMS:
126 		return (sysctl_struct(oldp, oldlenp, newp, newlen,
127 		    gp->froms, gp->fromssize));
128 	case GPROF_TOS:
129 		return (sysctl_struct(oldp, oldlenp, newp, newlen,
130 		    gp->tos, gp->tossize));
131 	case GPROF_GMONPARAM:
132 		return (sysctl_rdstruct(oldp, oldlenp, newp, gp, sizeof *gp));
133 	default:
134 		return (EOPNOTSUPP);
135 	}
136 	/* NOTREACHED */
137 }
138 #endif /* GPROF */
139 
140 /*
141  * Profiling system call.
142  *
143  * The scale factor is a fixed point number with 16 bits of fraction, so that
144  * 1.0 is represented as 0x10000.  A scale factor of 0 turns off profiling.
145  */
146 struct profil_args {
147 	caddr_t	samples;
148 	u_int	size;
149 	u_int	offset;
150 	u_int	scale;
151 };
152 /* ARGSUSED */
153 int
154 profil(p, uap, retval)
155 	struct proc *p;
156 	register struct profil_args *uap;
157 	int *retval;
158 {
159 	register struct uprof *upp;
160 	int s;
161 
162 	if (uap->scale > (1 << 16))
163 		return (EINVAL);
164 	if (uap->scale == 0) {
165 		stopprofclock(p);
166 		return (0);
167 	}
168 	upp = &p->p_stats->p_prof;
169 
170 	/* Block profile interrupts while changing state. */
171 	s = splstatclock();
172 	upp->pr_off = uap->offset;
173 	upp->pr_scale = uap->scale;
174 	upp->pr_base = uap->samples;
175 	upp->pr_size = uap->size;
176 	startprofclock(p);
177 	splx(s);
178 
179 	return (0);
180 }
181 
182 /*
183  * Scale is a fixed-point number with the binary point 16 bits
184  * into the value, and is <= 1.0.  pc is at most 32 bits, so the
185  * intermediate result is at most 48 bits.
186  */
187 #define	PC_TO_INDEX(pc, prof) \
188 	((int)(((u_quad_t)((pc) - (prof)->pr_off) * \
189 	    (u_quad_t)((prof)->pr_scale)) >> 16) & ~1)
190 
191 /*
192  * Collect user-level profiling statistics; called on a profiling tick,
193  * when a process is running in user-mode.  This routine may be called
194  * from an interrupt context.  We try to update the user profiling buffers
195  * cheaply with fuswintr() and suswintr().  If that fails, we revert to
196  * an AST that will vector us to trap() with a context in which copyin
197  * and copyout will work.  Trap will then call addupc_task().
198  *
199  * Note that we may (rarely) not get around to the AST soon enough, and
200  * lose profile ticks when the next tick overwrites this one, but in this
201  * case the system is overloaded and the profile is probably already
202  * inaccurate.
203  */
204 void
205 addupc_intr(p, pc, ticks)
206 	register struct proc *p;
207 	register u_long pc;
208 	u_int ticks;
209 {
210 	register struct uprof *prof;
211 	register caddr_t addr;
212 	register u_int i;
213 	register int v;
214 
215 	if (ticks == 0)
216 		return;
217 	prof = &p->p_stats->p_prof;
218 	if (pc < prof->pr_off ||
219 	    (i = PC_TO_INDEX(pc, prof)) >= prof->pr_size)
220 		return;			/* out of range; ignore */
221 
222 	addr = prof->pr_base + i;
223 	if ((v = fuswintr(addr)) == -1 || suswintr(addr, v + ticks) == -1) {
224 		prof->pr_addr = pc;
225 		prof->pr_ticks = ticks;
226 		need_proftick(p);
227 	}
228 }
229 
230 /*
231  * Much like before, but we can afford to take faults here.  If the
232  * update fails, we simply turn off profiling.
233  */
234 void
235 addupc_task(p, pc, ticks)
236 	register struct proc *p;
237 	register u_long pc;
238 	u_int ticks;
239 {
240 	register struct uprof *prof;
241 	register caddr_t addr;
242 	register u_int i;
243 	u_short v;
244 
245 	/* Testing P_PROFIL may be unnecessary, but is certainly safe. */
246 	if ((p->p_flag & P_PROFIL) == 0 || ticks == 0)
247 		return;
248 
249 	prof = &p->p_stats->p_prof;
250 	if (pc < prof->pr_off ||
251 	    (i = PC_TO_INDEX(pc, prof)) >= prof->pr_size)
252 		return;
253 
254 	addr = prof->pr_base + i;
255 	if (copyin(addr, (caddr_t)&v, sizeof(v)) == 0) {
256 		v += ticks;
257 		if (copyout((caddr_t)&v, addr, sizeof(v)) == 0)
258 			return;
259 	}
260 	stopprofclock(p);
261 }
262