1 /*
2  * Copyright (c) 1991, 1992 Paul Kranenburg <pk@cs.few.eur.nl>
3  * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
4  * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
5  * Copyright (c) 1996-1999 Wichert Akkerman <wichert@cistron.nl>
6  * Copyright (c) 1999 IBM Deutschland Entwicklung GmbH, IBM Corporation
7  *                     Linux for s390 port by D.J. Barrow
8  *                    <barrow_dj@mail.yahoo.com,djbarrow@de.ibm.com>
9  * Copyright (c) 2004 Roland McGrath <roland@redhat.com>
10  * Copyright (c) 2006 Dmitry V. Levin <ldv@altlinux.org>
11  * Copyright (c) 2006-2018 The strace developers.
12  * All rights reserved.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. The name of the author may not be used to endorse or promote products
23  *    derived from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35  */
36 
37 #include "defs.h"
38 
39 /* Per-syscall stats structure */
40 struct call_counts {
41 	/* time may be total latency or system time */
42 	struct timeval time;
43 	unsigned int calls, errors;
44 };
45 
46 static struct call_counts *countv[SUPPORTED_PERSONALITIES];
47 #define counts (countv[current_personality])
48 
49 static struct timeval shortest = { 1000000, 0 };
50 
51 void
count_syscall(struct tcb * tcp,const struct timeval * syscall_exiting_tv)52 count_syscall(struct tcb *tcp, const struct timeval *syscall_exiting_tv)
53 {
54 	struct timeval wtv;
55 	struct timeval *tv = &wtv;
56 	struct call_counts *cc;
57 
58 	if (!scno_in_range(tcp->scno))
59 		return;
60 
61 	if (!counts)
62 		counts = xcalloc(nsyscalls, sizeof(*counts));
63 	cc = &counts[tcp->scno];
64 
65 	cc->calls++;
66 	if (syserror(tcp))
67 		cc->errors++;
68 
69 	/* tv = wall clock time spent while in syscall */
70 	tv_sub(tv, syscall_exiting_tv, &tcp->etime);
71 
72 	/* Spent more wall clock time than spent system time? (usually yes) */
73 	if (tv_cmp(tv, &tcp->dtime) > 0) {
74 		static struct timeval one_tick = { -1, 0 };
75 
76 		if (one_tick.tv_sec == -1) {
77 			/* Initialize it.  */
78 			struct itimerval it;
79 
80 			memset(&it, 0, sizeof(it));
81 			it.it_interval.tv_usec = 1;
82 			setitimer(ITIMER_REAL, &it, NULL);
83 			getitimer(ITIMER_REAL, &it);
84 			one_tick = it.it_interval;
85 //FIXME: this hack doesn't work (tested on linux-3.6.11): one_tick = 0.000000
86 //tprintf(" one_tick.tv_usec:%u\n", (unsigned)one_tick.tv_usec);
87 		}
88 
89 		if (tv_nz(&tcp->dtime))
90 			/* tv = system time spent, if it isn't 0 */
91 			tv = &tcp->dtime;
92 		else if (tv_cmp(tv, &one_tick) > 0) {
93 			/* tv = smallest "sane" time interval */
94 			if (tv_cmp(&shortest, &one_tick) < 0)
95 				tv = &shortest;
96 			else
97 				tv = &one_tick;
98 		}
99 	}
100 	if (tv_cmp(tv, &shortest) < 0)
101 		shortest = *tv;
102 	tv_add(&cc->time, &cc->time, count_wallclock ? &wtv : tv);
103 }
104 
105 static int
time_cmp(void * a,void * b)106 time_cmp(void *a, void *b)
107 {
108 	return -tv_cmp(&counts[*((int *) a)].time,
109 		       &counts[*((int *) b)].time);
110 }
111 
112 static int
syscall_cmp(void * a,void * b)113 syscall_cmp(void *a, void *b)
114 {
115 	const char *a_name = sysent[*((int *) a)].sys_name;
116 	const char *b_name = sysent[*((int *) b)].sys_name;
117 	return strcmp(a_name ? a_name : "", b_name ? b_name : "");
118 }
119 
120 static int
count_cmp(void * a,void * b)121 count_cmp(void *a, void *b)
122 {
123 	int     m = counts[*((int *) a)].calls;
124 	int     n = counts[*((int *) b)].calls;
125 
126 	return (m < n) ? 1 : (m > n) ? -1 : 0;
127 }
128 
129 static int (*sortfun)();
130 static struct timeval overhead = { -1, -1 };
131 
132 void
set_sortby(const char * sortby)133 set_sortby(const char *sortby)
134 {
135 	if (strcmp(sortby, "time") == 0)
136 		sortfun = time_cmp;
137 	else if (strcmp(sortby, "calls") == 0)
138 		sortfun = count_cmp;
139 	else if (strcmp(sortby, "name") == 0)
140 		sortfun = syscall_cmp;
141 	else if (strcmp(sortby, "nothing") == 0)
142 		sortfun = NULL;
143 	else {
144 		error_msg_and_help("invalid sortby: '%s'", sortby);
145 	}
146 }
147 
set_overhead(int n)148 void set_overhead(int n)
149 {
150 	overhead.tv_sec = n / 1000000;
151 	overhead.tv_usec = n % 1000000;
152 }
153 
154 static void
call_summary_pers(FILE * outf)155 call_summary_pers(FILE *outf)
156 {
157 	static const char dashes[]  = "----------------";
158 	static const char header[]  = "%6.6s %11.11s %11.11s %9.9s %9.9s %s\n";
159 	static const char data[]    = "%6.2f %11.6f %11lu %9u %9.u %s\n";
160 	static const char summary[] = "%6.6s %11.6f %11.11s %9u %9.u %s\n";
161 
162 	unsigned int i;
163 	unsigned int call_cum, error_cum;
164 	struct timeval tv_cum, dtv;
165 	double  float_tv_cum;
166 	double  percent;
167 	unsigned int *sorted_count;
168 
169 	fprintf(outf, header,
170 		"% time", "seconds", "usecs/call",
171 		"calls", "errors", "syscall");
172 	fprintf(outf, header, dashes, dashes, dashes, dashes, dashes, dashes);
173 
174 	sorted_count = xcalloc(sizeof(sorted_count[0]), nsyscalls);
175 	call_cum = error_cum = tv_cum.tv_sec = tv_cum.tv_usec = 0;
176 	if (overhead.tv_sec == -1) {
177 		tv_mul(&overhead, &shortest, 8);
178 		tv_div(&overhead, &overhead, 10);
179 	}
180 	for (i = 0; i < nsyscalls; i++) {
181 		sorted_count[i] = i;
182 		if (counts == NULL || counts[i].calls == 0)
183 			continue;
184 		tv_mul(&dtv, &overhead, counts[i].calls);
185 		tv_sub(&counts[i].time, &counts[i].time, &dtv);
186 		call_cum += counts[i].calls;
187 		error_cum += counts[i].errors;
188 		tv_add(&tv_cum, &tv_cum, &counts[i].time);
189 	}
190 	float_tv_cum = tv_float(&tv_cum);
191 	if (counts) {
192 		if (sortfun)
193 			qsort((void *) sorted_count, nsyscalls,
194 			      sizeof(sorted_count[0]), sortfun);
195 		for (i = 0; i < nsyscalls; i++) {
196 			double float_syscall_time;
197 			unsigned int idx = sorted_count[i];
198 			struct call_counts *cc = &counts[idx];
199 			if (cc->calls == 0)
200 				continue;
201 			tv_div(&dtv, &cc->time, cc->calls);
202 			float_syscall_time = tv_float(&cc->time);
203 			percent = (100.0 * float_syscall_time);
204 			if (percent != 0.0)
205 				   percent /= float_tv_cum;
206 			/* else: float_tv_cum can be 0.0 too and we get 0/0 = NAN */
207 			fprintf(outf, data,
208 				percent, float_syscall_time,
209 				(long) (1000000 * dtv.tv_sec + dtv.tv_usec),
210 				cc->calls, cc->errors, sysent[idx].sys_name);
211 		}
212 	}
213 	free(sorted_count);
214 
215 	fprintf(outf, header, dashes, dashes, dashes, dashes, dashes, dashes);
216 	fprintf(outf, summary,
217 		"100.00", float_tv_cum, "",
218 		call_cum, error_cum, "total");
219 }
220 
221 void
call_summary(FILE * outf)222 call_summary(FILE *outf)
223 {
224 	unsigned int i, old_pers = current_personality;
225 
226 	for (i = 0; i < SUPPORTED_PERSONALITIES; ++i) {
227 		if (!countv[i])
228 			continue;
229 
230 		if (current_personality != i)
231 			set_personality(i);
232 		if (i)
233 			fprintf(outf,
234 				"System call usage summary for %s mode:\n",
235 				personality_names[i]);
236 		call_summary_pers(outf);
237 	}
238 
239 	if (old_pers != current_personality)
240 		set_personality(old_pers);
241 }
242